aws-sdk
Version:
AWS SDK for JavaScript
1,155 lines (1,154 loc) • 90.1 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class MailManager extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: MailManager.Types.ClientConfiguration)
config: Config & MailManager.Types.ClientConfiguration;
/**
* Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.
*/
createAddonInstance(params: MailManager.Types.CreateAddonInstanceRequest, callback?: (err: AWSError, data: MailManager.Types.CreateAddonInstanceResponse) => void): Request<MailManager.Types.CreateAddonInstanceResponse, AWSError>;
/**
* Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.
*/
createAddonInstance(callback?: (err: AWSError, data: MailManager.Types.CreateAddonInstanceResponse) => void): Request<MailManager.Types.CreateAddonInstanceResponse, AWSError>;
/**
* Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
*/
createAddonSubscription(params: MailManager.Types.CreateAddonSubscriptionRequest, callback?: (err: AWSError, data: MailManager.Types.CreateAddonSubscriptionResponse) => void): Request<MailManager.Types.CreateAddonSubscriptionResponse, AWSError>;
/**
* Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
*/
createAddonSubscription(callback?: (err: AWSError, data: MailManager.Types.CreateAddonSubscriptionResponse) => void): Request<MailManager.Types.CreateAddonSubscriptionResponse, AWSError>;
/**
* Creates a new email archive resource for storing and retaining emails.
*/
createArchive(params: MailManager.Types.CreateArchiveRequest, callback?: (err: AWSError, data: MailManager.Types.CreateArchiveResponse) => void): Request<MailManager.Types.CreateArchiveResponse, AWSError>;
/**
* Creates a new email archive resource for storing and retaining emails.
*/
createArchive(callback?: (err: AWSError, data: MailManager.Types.CreateArchiveResponse) => void): Request<MailManager.Types.CreateArchiveResponse, AWSError>;
/**
* Provision a new ingress endpoint resource.
*/
createIngressPoint(params: MailManager.Types.CreateIngressPointRequest, callback?: (err: AWSError, data: MailManager.Types.CreateIngressPointResponse) => void): Request<MailManager.Types.CreateIngressPointResponse, AWSError>;
/**
* Provision a new ingress endpoint resource.
*/
createIngressPoint(callback?: (err: AWSError, data: MailManager.Types.CreateIngressPointResponse) => void): Request<MailManager.Types.CreateIngressPointResponse, AWSError>;
/**
* Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
*/
createRelay(params: MailManager.Types.CreateRelayRequest, callback?: (err: AWSError, data: MailManager.Types.CreateRelayResponse) => void): Request<MailManager.Types.CreateRelayResponse, AWSError>;
/**
* Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
*/
createRelay(callback?: (err: AWSError, data: MailManager.Types.CreateRelayResponse) => void): Request<MailManager.Types.CreateRelayResponse, AWSError>;
/**
* Provision a new rule set.
*/
createRuleSet(params: MailManager.Types.CreateRuleSetRequest, callback?: (err: AWSError, data: MailManager.Types.CreateRuleSetResponse) => void): Request<MailManager.Types.CreateRuleSetResponse, AWSError>;
/**
* Provision a new rule set.
*/
createRuleSet(callback?: (err: AWSError, data: MailManager.Types.CreateRuleSetResponse) => void): Request<MailManager.Types.CreateRuleSetResponse, AWSError>;
/**
* Provision a new traffic policy resource.
*/
createTrafficPolicy(params: MailManager.Types.CreateTrafficPolicyRequest, callback?: (err: AWSError, data: MailManager.Types.CreateTrafficPolicyResponse) => void): Request<MailManager.Types.CreateTrafficPolicyResponse, AWSError>;
/**
* Provision a new traffic policy resource.
*/
createTrafficPolicy(callback?: (err: AWSError, data: MailManager.Types.CreateTrafficPolicyResponse) => void): Request<MailManager.Types.CreateTrafficPolicyResponse, AWSError>;
/**
* Deletes an Add On instance.
*/
deleteAddonInstance(params: MailManager.Types.DeleteAddonInstanceRequest, callback?: (err: AWSError, data: MailManager.Types.DeleteAddonInstanceResponse) => void): Request<MailManager.Types.DeleteAddonInstanceResponse, AWSError>;
/**
* Deletes an Add On instance.
*/
deleteAddonInstance(callback?: (err: AWSError, data: MailManager.Types.DeleteAddonInstanceResponse) => void): Request<MailManager.Types.DeleteAddonInstanceResponse, AWSError>;
/**
* Deletes an Add On subscription.
*/
deleteAddonSubscription(params: MailManager.Types.DeleteAddonSubscriptionRequest, callback?: (err: AWSError, data: MailManager.Types.DeleteAddonSubscriptionResponse) => void): Request<MailManager.Types.DeleteAddonSubscriptionResponse, AWSError>;
/**
* Deletes an Add On subscription.
*/
deleteAddonSubscription(callback?: (err: AWSError, data: MailManager.Types.DeleteAddonSubscriptionResponse) => void): Request<MailManager.Types.DeleteAddonSubscriptionResponse, AWSError>;
/**
* Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.
*/
deleteArchive(params: MailManager.Types.DeleteArchiveRequest, callback?: (err: AWSError, data: MailManager.Types.DeleteArchiveResponse) => void): Request<MailManager.Types.DeleteArchiveResponse, AWSError>;
/**
* Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.
*/
deleteArchive(callback?: (err: AWSError, data: MailManager.Types.DeleteArchiveResponse) => void): Request<MailManager.Types.DeleteArchiveResponse, AWSError>;
/**
* Delete an ingress endpoint resource.
*/
deleteIngressPoint(params: MailManager.Types.DeleteIngressPointRequest, callback?: (err: AWSError, data: MailManager.Types.DeleteIngressPointResponse) => void): Request<MailManager.Types.DeleteIngressPointResponse, AWSError>;
/**
* Delete an ingress endpoint resource.
*/
deleteIngressPoint(callback?: (err: AWSError, data: MailManager.Types.DeleteIngressPointResponse) => void): Request<MailManager.Types.DeleteIngressPointResponse, AWSError>;
/**
* Deletes an existing relay resource.
*/
deleteRelay(params: MailManager.Types.DeleteRelayRequest, callback?: (err: AWSError, data: MailManager.Types.DeleteRelayResponse) => void): Request<MailManager.Types.DeleteRelayResponse, AWSError>;
/**
* Deletes an existing relay resource.
*/
deleteRelay(callback?: (err: AWSError, data: MailManager.Types.DeleteRelayResponse) => void): Request<MailManager.Types.DeleteRelayResponse, AWSError>;
/**
* Delete a rule set.
*/
deleteRuleSet(params: MailManager.Types.DeleteRuleSetRequest, callback?: (err: AWSError, data: MailManager.Types.DeleteRuleSetResponse) => void): Request<MailManager.Types.DeleteRuleSetResponse, AWSError>;
/**
* Delete a rule set.
*/
deleteRuleSet(callback?: (err: AWSError, data: MailManager.Types.DeleteRuleSetResponse) => void): Request<MailManager.Types.DeleteRuleSetResponse, AWSError>;
/**
* Delete a traffic policy resource.
*/
deleteTrafficPolicy(params: MailManager.Types.DeleteTrafficPolicyRequest, callback?: (err: AWSError, data: MailManager.Types.DeleteTrafficPolicyResponse) => void): Request<MailManager.Types.DeleteTrafficPolicyResponse, AWSError>;
/**
* Delete a traffic policy resource.
*/
deleteTrafficPolicy(callback?: (err: AWSError, data: MailManager.Types.DeleteTrafficPolicyResponse) => void): Request<MailManager.Types.DeleteTrafficPolicyResponse, AWSError>;
/**
* Gets detailed information about an Add On instance.
*/
getAddonInstance(params: MailManager.Types.GetAddonInstanceRequest, callback?: (err: AWSError, data: MailManager.Types.GetAddonInstanceResponse) => void): Request<MailManager.Types.GetAddonInstanceResponse, AWSError>;
/**
* Gets detailed information about an Add On instance.
*/
getAddonInstance(callback?: (err: AWSError, data: MailManager.Types.GetAddonInstanceResponse) => void): Request<MailManager.Types.GetAddonInstanceResponse, AWSError>;
/**
* Gets detailed information about an Add On subscription.
*/
getAddonSubscription(params: MailManager.Types.GetAddonSubscriptionRequest, callback?: (err: AWSError, data: MailManager.Types.GetAddonSubscriptionResponse) => void): Request<MailManager.Types.GetAddonSubscriptionResponse, AWSError>;
/**
* Gets detailed information about an Add On subscription.
*/
getAddonSubscription(callback?: (err: AWSError, data: MailManager.Types.GetAddonSubscriptionResponse) => void): Request<MailManager.Types.GetAddonSubscriptionResponse, AWSError>;
/**
* Retrieves the full details and current state of a specified email archive.
*/
getArchive(params: MailManager.Types.GetArchiveRequest, callback?: (err: AWSError, data: MailManager.Types.GetArchiveResponse) => void): Request<MailManager.Types.GetArchiveResponse, AWSError>;
/**
* Retrieves the full details and current state of a specified email archive.
*/
getArchive(callback?: (err: AWSError, data: MailManager.Types.GetArchiveResponse) => void): Request<MailManager.Types.GetArchiveResponse, AWSError>;
/**
* Retrieves the details and current status of a specific email archive export job.
*/
getArchiveExport(params: MailManager.Types.GetArchiveExportRequest, callback?: (err: AWSError, data: MailManager.Types.GetArchiveExportResponse) => void): Request<MailManager.Types.GetArchiveExportResponse, AWSError>;
/**
* Retrieves the details and current status of a specific email archive export job.
*/
getArchiveExport(callback?: (err: AWSError, data: MailManager.Types.GetArchiveExportResponse) => void): Request<MailManager.Types.GetArchiveExportResponse, AWSError>;
/**
* Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
*/
getArchiveMessage(params: MailManager.Types.GetArchiveMessageRequest, callback?: (err: AWSError, data: MailManager.Types.GetArchiveMessageResponse) => void): Request<MailManager.Types.GetArchiveMessageResponse, AWSError>;
/**
* Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
*/
getArchiveMessage(callback?: (err: AWSError, data: MailManager.Types.GetArchiveMessageResponse) => void): Request<MailManager.Types.GetArchiveMessageResponse, AWSError>;
/**
* Returns the textual content of a specific email message stored in the archive. Attachments are not included.
*/
getArchiveMessageContent(params: MailManager.Types.GetArchiveMessageContentRequest, callback?: (err: AWSError, data: MailManager.Types.GetArchiveMessageContentResponse) => void): Request<MailManager.Types.GetArchiveMessageContentResponse, AWSError>;
/**
* Returns the textual content of a specific email message stored in the archive. Attachments are not included.
*/
getArchiveMessageContent(callback?: (err: AWSError, data: MailManager.Types.GetArchiveMessageContentResponse) => void): Request<MailManager.Types.GetArchiveMessageContentResponse, AWSError>;
/**
* Retrieves the details and current status of a specific email archive search job.
*/
getArchiveSearch(params: MailManager.Types.GetArchiveSearchRequest, callback?: (err: AWSError, data: MailManager.Types.GetArchiveSearchResponse) => void): Request<MailManager.Types.GetArchiveSearchResponse, AWSError>;
/**
* Retrieves the details and current status of a specific email archive search job.
*/
getArchiveSearch(callback?: (err: AWSError, data: MailManager.Types.GetArchiveSearchResponse) => void): Request<MailManager.Types.GetArchiveSearchResponse, AWSError>;
/**
* Returns the results of a completed email archive search job.
*/
getArchiveSearchResults(params: MailManager.Types.GetArchiveSearchResultsRequest, callback?: (err: AWSError, data: MailManager.Types.GetArchiveSearchResultsResponse) => void): Request<MailManager.Types.GetArchiveSearchResultsResponse, AWSError>;
/**
* Returns the results of a completed email archive search job.
*/
getArchiveSearchResults(callback?: (err: AWSError, data: MailManager.Types.GetArchiveSearchResultsResponse) => void): Request<MailManager.Types.GetArchiveSearchResultsResponse, AWSError>;
/**
* Fetch ingress endpoint resource attributes.
*/
getIngressPoint(params: MailManager.Types.GetIngressPointRequest, callback?: (err: AWSError, data: MailManager.Types.GetIngressPointResponse) => void): Request<MailManager.Types.GetIngressPointResponse, AWSError>;
/**
* Fetch ingress endpoint resource attributes.
*/
getIngressPoint(callback?: (err: AWSError, data: MailManager.Types.GetIngressPointResponse) => void): Request<MailManager.Types.GetIngressPointResponse, AWSError>;
/**
* Fetch the relay resource and it's attributes.
*/
getRelay(params: MailManager.Types.GetRelayRequest, callback?: (err: AWSError, data: MailManager.Types.GetRelayResponse) => void): Request<MailManager.Types.GetRelayResponse, AWSError>;
/**
* Fetch the relay resource and it's attributes.
*/
getRelay(callback?: (err: AWSError, data: MailManager.Types.GetRelayResponse) => void): Request<MailManager.Types.GetRelayResponse, AWSError>;
/**
* Fetch attributes of a rule set.
*/
getRuleSet(params: MailManager.Types.GetRuleSetRequest, callback?: (err: AWSError, data: MailManager.Types.GetRuleSetResponse) => void): Request<MailManager.Types.GetRuleSetResponse, AWSError>;
/**
* Fetch attributes of a rule set.
*/
getRuleSet(callback?: (err: AWSError, data: MailManager.Types.GetRuleSetResponse) => void): Request<MailManager.Types.GetRuleSetResponse, AWSError>;
/**
* Fetch attributes of a traffic policy resource.
*/
getTrafficPolicy(params: MailManager.Types.GetTrafficPolicyRequest, callback?: (err: AWSError, data: MailManager.Types.GetTrafficPolicyResponse) => void): Request<MailManager.Types.GetTrafficPolicyResponse, AWSError>;
/**
* Fetch attributes of a traffic policy resource.
*/
getTrafficPolicy(callback?: (err: AWSError, data: MailManager.Types.GetTrafficPolicyResponse) => void): Request<MailManager.Types.GetTrafficPolicyResponse, AWSError>;
/**
* Lists all Add On instances in your account.
*/
listAddonInstances(params: MailManager.Types.ListAddonInstancesRequest, callback?: (err: AWSError, data: MailManager.Types.ListAddonInstancesResponse) => void): Request<MailManager.Types.ListAddonInstancesResponse, AWSError>;
/**
* Lists all Add On instances in your account.
*/
listAddonInstances(callback?: (err: AWSError, data: MailManager.Types.ListAddonInstancesResponse) => void): Request<MailManager.Types.ListAddonInstancesResponse, AWSError>;
/**
* Lists all Add On subscriptions in your account.
*/
listAddonSubscriptions(params: MailManager.Types.ListAddonSubscriptionsRequest, callback?: (err: AWSError, data: MailManager.Types.ListAddonSubscriptionsResponse) => void): Request<MailManager.Types.ListAddonSubscriptionsResponse, AWSError>;
/**
* Lists all Add On subscriptions in your account.
*/
listAddonSubscriptions(callback?: (err: AWSError, data: MailManager.Types.ListAddonSubscriptionsResponse) => void): Request<MailManager.Types.ListAddonSubscriptionsResponse, AWSError>;
/**
* Returns a list of email archive export jobs.
*/
listArchiveExports(params: MailManager.Types.ListArchiveExportsRequest, callback?: (err: AWSError, data: MailManager.Types.ListArchiveExportsResponse) => void): Request<MailManager.Types.ListArchiveExportsResponse, AWSError>;
/**
* Returns a list of email archive export jobs.
*/
listArchiveExports(callback?: (err: AWSError, data: MailManager.Types.ListArchiveExportsResponse) => void): Request<MailManager.Types.ListArchiveExportsResponse, AWSError>;
/**
* Returns a list of email archive search jobs.
*/
listArchiveSearches(params: MailManager.Types.ListArchiveSearchesRequest, callback?: (err: AWSError, data: MailManager.Types.ListArchiveSearchesResponse) => void): Request<MailManager.Types.ListArchiveSearchesResponse, AWSError>;
/**
* Returns a list of email archive search jobs.
*/
listArchiveSearches(callback?: (err: AWSError, data: MailManager.Types.ListArchiveSearchesResponse) => void): Request<MailManager.Types.ListArchiveSearchesResponse, AWSError>;
/**
* Returns a list of all email archives in your account.
*/
listArchives(params: MailManager.Types.ListArchivesRequest, callback?: (err: AWSError, data: MailManager.Types.ListArchivesResponse) => void): Request<MailManager.Types.ListArchivesResponse, AWSError>;
/**
* Returns a list of all email archives in your account.
*/
listArchives(callback?: (err: AWSError, data: MailManager.Types.ListArchivesResponse) => void): Request<MailManager.Types.ListArchivesResponse, AWSError>;
/**
* List all ingress endpoint resources.
*/
listIngressPoints(params: MailManager.Types.ListIngressPointsRequest, callback?: (err: AWSError, data: MailManager.Types.ListIngressPointsResponse) => void): Request<MailManager.Types.ListIngressPointsResponse, AWSError>;
/**
* List all ingress endpoint resources.
*/
listIngressPoints(callback?: (err: AWSError, data: MailManager.Types.ListIngressPointsResponse) => void): Request<MailManager.Types.ListIngressPointsResponse, AWSError>;
/**
* Lists all the existing relay resources.
*/
listRelays(params: MailManager.Types.ListRelaysRequest, callback?: (err: AWSError, data: MailManager.Types.ListRelaysResponse) => void): Request<MailManager.Types.ListRelaysResponse, AWSError>;
/**
* Lists all the existing relay resources.
*/
listRelays(callback?: (err: AWSError, data: MailManager.Types.ListRelaysResponse) => void): Request<MailManager.Types.ListRelaysResponse, AWSError>;
/**
* List rule sets for this account.
*/
listRuleSets(params: MailManager.Types.ListRuleSetsRequest, callback?: (err: AWSError, data: MailManager.Types.ListRuleSetsResponse) => void): Request<MailManager.Types.ListRuleSetsResponse, AWSError>;
/**
* List rule sets for this account.
*/
listRuleSets(callback?: (err: AWSError, data: MailManager.Types.ListRuleSetsResponse) => void): Request<MailManager.Types.ListRuleSetsResponse, AWSError>;
/**
* Retrieves the list of tags (keys and values) assigned to the resource.
*/
listTagsForResource(params: MailManager.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MailManager.Types.ListTagsForResourceResponse) => void): Request<MailManager.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves the list of tags (keys and values) assigned to the resource.
*/
listTagsForResource(callback?: (err: AWSError, data: MailManager.Types.ListTagsForResourceResponse) => void): Request<MailManager.Types.ListTagsForResourceResponse, AWSError>;
/**
* List traffic policy resources.
*/
listTrafficPolicies(params: MailManager.Types.ListTrafficPoliciesRequest, callback?: (err: AWSError, data: MailManager.Types.ListTrafficPoliciesResponse) => void): Request<MailManager.Types.ListTrafficPoliciesResponse, AWSError>;
/**
* List traffic policy resources.
*/
listTrafficPolicies(callback?: (err: AWSError, data: MailManager.Types.ListTrafficPoliciesResponse) => void): Request<MailManager.Types.ListTrafficPoliciesResponse, AWSError>;
/**
* Initiates an export of emails from the specified archive.
*/
startArchiveExport(params: MailManager.Types.StartArchiveExportRequest, callback?: (err: AWSError, data: MailManager.Types.StartArchiveExportResponse) => void): Request<MailManager.Types.StartArchiveExportResponse, AWSError>;
/**
* Initiates an export of emails from the specified archive.
*/
startArchiveExport(callback?: (err: AWSError, data: MailManager.Types.StartArchiveExportResponse) => void): Request<MailManager.Types.StartArchiveExportResponse, AWSError>;
/**
* Initiates a search across emails in the specified archive.
*/
startArchiveSearch(params: MailManager.Types.StartArchiveSearchRequest, callback?: (err: AWSError, data: MailManager.Types.StartArchiveSearchResponse) => void): Request<MailManager.Types.StartArchiveSearchResponse, AWSError>;
/**
* Initiates a search across emails in the specified archive.
*/
startArchiveSearch(callback?: (err: AWSError, data: MailManager.Types.StartArchiveSearchResponse) => void): Request<MailManager.Types.StartArchiveSearchResponse, AWSError>;
/**
* Stops an in-progress export of emails from an archive.
*/
stopArchiveExport(params: MailManager.Types.StopArchiveExportRequest, callback?: (err: AWSError, data: MailManager.Types.StopArchiveExportResponse) => void): Request<MailManager.Types.StopArchiveExportResponse, AWSError>;
/**
* Stops an in-progress export of emails from an archive.
*/
stopArchiveExport(callback?: (err: AWSError, data: MailManager.Types.StopArchiveExportResponse) => void): Request<MailManager.Types.StopArchiveExportResponse, AWSError>;
/**
* Stops an in-progress archive search job.
*/
stopArchiveSearch(params: MailManager.Types.StopArchiveSearchRequest, callback?: (err: AWSError, data: MailManager.Types.StopArchiveSearchResponse) => void): Request<MailManager.Types.StopArchiveSearchResponse, AWSError>;
/**
* Stops an in-progress archive search job.
*/
stopArchiveSearch(callback?: (err: AWSError, data: MailManager.Types.StopArchiveSearchResponse) => void): Request<MailManager.Types.StopArchiveSearchResponse, AWSError>;
/**
* Adds one or more tags (keys and values) to a specified resource.
*/
tagResource(params: MailManager.Types.TagResourceRequest, callback?: (err: AWSError, data: MailManager.Types.TagResourceResponse) => void): Request<MailManager.Types.TagResourceResponse, AWSError>;
/**
* Adds one or more tags (keys and values) to a specified resource.
*/
tagResource(callback?: (err: AWSError, data: MailManager.Types.TagResourceResponse) => void): Request<MailManager.Types.TagResourceResponse, AWSError>;
/**
* Remove one or more tags (keys and values) from a specified resource.
*/
untagResource(params: MailManager.Types.UntagResourceRequest, callback?: (err: AWSError, data: MailManager.Types.UntagResourceResponse) => void): Request<MailManager.Types.UntagResourceResponse, AWSError>;
/**
* Remove one or more tags (keys and values) from a specified resource.
*/
untagResource(callback?: (err: AWSError, data: MailManager.Types.UntagResourceResponse) => void): Request<MailManager.Types.UntagResourceResponse, AWSError>;
/**
* Updates the attributes of an existing email archive.
*/
updateArchive(params: MailManager.Types.UpdateArchiveRequest, callback?: (err: AWSError, data: MailManager.Types.UpdateArchiveResponse) => void): Request<MailManager.Types.UpdateArchiveResponse, AWSError>;
/**
* Updates the attributes of an existing email archive.
*/
updateArchive(callback?: (err: AWSError, data: MailManager.Types.UpdateArchiveResponse) => void): Request<MailManager.Types.UpdateArchiveResponse, AWSError>;
/**
* Update attributes of a provisioned ingress endpoint resource.
*/
updateIngressPoint(params: MailManager.Types.UpdateIngressPointRequest, callback?: (err: AWSError, data: MailManager.Types.UpdateIngressPointResponse) => void): Request<MailManager.Types.UpdateIngressPointResponse, AWSError>;
/**
* Update attributes of a provisioned ingress endpoint resource.
*/
updateIngressPoint(callback?: (err: AWSError, data: MailManager.Types.UpdateIngressPointResponse) => void): Request<MailManager.Types.UpdateIngressPointResponse, AWSError>;
/**
* Updates the attributes of an existing relay resource.
*/
updateRelay(params: MailManager.Types.UpdateRelayRequest, callback?: (err: AWSError, data: MailManager.Types.UpdateRelayResponse) => void): Request<MailManager.Types.UpdateRelayResponse, AWSError>;
/**
* Updates the attributes of an existing relay resource.
*/
updateRelay(callback?: (err: AWSError, data: MailManager.Types.UpdateRelayResponse) => void): Request<MailManager.Types.UpdateRelayResponse, AWSError>;
/**
* >Update attributes of an already provisioned rule set.
*/
updateRuleSet(params: MailManager.Types.UpdateRuleSetRequest, callback?: (err: AWSError, data: MailManager.Types.UpdateRuleSetResponse) => void): Request<MailManager.Types.UpdateRuleSetResponse, AWSError>;
/**
* >Update attributes of an already provisioned rule set.
*/
updateRuleSet(callback?: (err: AWSError, data: MailManager.Types.UpdateRuleSetResponse) => void): Request<MailManager.Types.UpdateRuleSetResponse, AWSError>;
/**
* Update attributes of an already provisioned traffic policy resource.
*/
updateTrafficPolicy(params: MailManager.Types.UpdateTrafficPolicyRequest, callback?: (err: AWSError, data: MailManager.Types.UpdateTrafficPolicyResponse) => void): Request<MailManager.Types.UpdateTrafficPolicyResponse, AWSError>;
/**
* Update attributes of an already provisioned traffic policy resource.
*/
updateTrafficPolicy(callback?: (err: AWSError, data: MailManager.Types.UpdateTrafficPolicyResponse) => void): Request<MailManager.Types.UpdateTrafficPolicyResponse, AWSError>;
}
declare namespace MailManager {
export type AcceptAction = "ALLOW"|"DENY"|string;
export type ActionFailurePolicy = "CONTINUE"|"DROP"|string;
export interface AddHeaderAction {
/**
* The name of the header to add to an email. The header must be prefixed with "X-". Headers are added regardless of whether the header name pre-existed in the email.
*/
HeaderName: HeaderName;
/**
* The value of the header to add to the email.
*/
HeaderValue: HeaderValue;
}
export interface AddonInstance {
/**
* The Amazon Resource Name (ARN) of the Add On instance.
*/
AddonInstanceArn?: AddonInstanceArn;
/**
* The unique ID of the Add On instance.
*/
AddonInstanceId?: AddonInstanceId;
/**
* The name of the Add On for the instance.
*/
AddonName?: AddonName;
/**
* The subscription ID for the instance.
*/
AddonSubscriptionId?: AddonSubscriptionId;
/**
* The timestamp of when the Add On instance was created.
*/
CreatedTimestamp?: Timestamp;
}
export type AddonInstanceArn = string;
export type AddonInstanceId = string;
export type AddonInstances = AddonInstance[];
export type AddonName = string;
export interface AddonSubscription {
/**
* The name of the Add On.
*/
AddonName?: AddonName;
/**
* The Amazon Resource Name (ARN) of the Add On subscription.
*/
AddonSubscriptionArn?: AddonSubscriptionArn;
/**
* The unique ID of the Add On subscription.
*/
AddonSubscriptionId?: AddonSubscriptionId;
/**
* The timestamp of when the Add On subscription was created.
*/
CreatedTimestamp?: Timestamp;
}
export type AddonSubscriptionArn = string;
export type AddonSubscriptionId = string;
export type AddonSubscriptions = AddonSubscription[];
export interface Analysis {
/**
* The Amazon Resource Name (ARN) of an Add On.
*/
Analyzer: AnalyzerArn;
/**
* The returned value from an Add On.
*/
ResultField: ResultField;
}
export type AnalyzerArn = string;
export interface Archive {
/**
* The unique identifier of the archive.
*/
ArchiveId: ArchiveIdString;
/**
* The unique name assigned to the archive.
*/
ArchiveName?: ArchiveNameString;
/**
* The current state of the archive: ACTIVE – The archive is ready and available for use. PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
*/
ArchiveState?: ArchiveState;
/**
* The timestamp of when the archive was last updated.
*/
LastUpdatedTimestamp?: Timestamp;
}
export interface ArchiveAction {
/**
* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.
*/
ActionFailurePolicy?: ActionFailurePolicy;
/**
* The identifier of the archive to send the email to.
*/
TargetArchive: NameOrArn;
}
export type ArchiveArn = string;
export type ArchiveBooleanEmailAttribute = "HAS_ATTACHMENTS"|string;
export interface ArchiveBooleanExpression {
/**
* The email attribute value to evaluate.
*/
Evaluate: ArchiveBooleanToEvaluate;
/**
* The boolean operator to use for evaluation.
*/
Operator: ArchiveBooleanOperator;
}
export type ArchiveBooleanOperator = "IS_TRUE"|"IS_FALSE"|string;
export interface ArchiveBooleanToEvaluate {
/**
* The name of the email attribute to evaluate.
*/
Attribute?: ArchiveBooleanEmailAttribute;
}
export interface ArchiveFilterCondition {
/**
* A boolean expression to evaluate against email attributes.
*/
BooleanExpression?: ArchiveBooleanExpression;
/**
* A string expression to evaluate against email attributes.
*/
StringExpression?: ArchiveStringExpression;
}
export type ArchiveFilterConditions = ArchiveFilterCondition[];
export interface ArchiveFilters {
/**
* The filter conditions for emails to include.
*/
Include?: ArchiveFilterConditions;
/**
* The filter conditions for emails to exclude.
*/
Unless?: ArchiveFilterConditions;
}
export type ArchiveId = string;
export type ArchiveIdString = string;
export type ArchiveNameString = string;
export interface ArchiveRetention {
/**
* The enum value sets the period for retaining emails in an archive.
*/
RetentionPeriod?: RetentionPeriod;
}
export type ArchiveState = "ACTIVE"|"PENDING_DELETION"|string;
export type ArchiveStringEmailAttribute = "TO"|"FROM"|"CC"|"SUBJECT"|string;
export interface ArchiveStringExpression {
/**
* The attribute of the email to evaluate.
*/
Evaluate: ArchiveStringToEvaluate;
/**
* The operator to use when evaluating the string values.
*/
Operator: ArchiveStringOperator;
/**
* The list of string values to evaluate the email attribute against.
*/
Values: StringValueList;
}
export type ArchiveStringOperator = "CONTAINS"|string;
export interface ArchiveStringToEvaluate {
/**
* The name of the email attribute to evaluate.
*/
Attribute?: ArchiveStringEmailAttribute;
}
export type ArchivedMessageId = string;
export type ArchivesList = Archive[];
export type Boolean = boolean;
export interface CreateAddonInstanceRequest {
/**
* The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.
*/
AddonSubscriptionId: AddonSubscriptionId;
/**
* A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*/
ClientToken?: IdempotencyToken;
/**
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/
Tags?: TagList;
}
export interface CreateAddonInstanceResponse {
/**
* The unique ID of the Add On instance created by this API.
*/
AddonInstanceId: AddonInstanceId;
}
export interface CreateAddonSubscriptionRequest {
/**
* The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
*/
AddonName: AddonName;
/**
* A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*/
ClientToken?: IdempotencyToken;
/**
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/
Tags?: TagList;
}
export interface CreateAddonSubscriptionResponse {
/**
* The unique ID of the Add On subscription created by this API.
*/
AddonSubscriptionId: AddonSubscriptionId;
}
export interface CreateArchiveRequest {
/**
* A unique name for the new archive.
*/
ArchiveName: ArchiveNameString;
/**
* A unique token Amazon SES uses to recognize retries of this request.
*/
ClientToken?: IdempotencyToken;
/**
* The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
*/
KmsKeyArn?: KmsKeyArn;
/**
* The period for retaining emails in the archive before automatic deletion.
*/
Retention?: ArchiveRetention;
/**
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/
Tags?: TagList;
}
export interface CreateArchiveResponse {
/**
* The unique identifier for the newly created archive.
*/
ArchiveId: ArchiveIdString;
}
export interface CreateIngressPointRequest {
/**
* A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*/
ClientToken?: IdempotencyToken;
/**
* If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
*/
IngressPointConfiguration?: IngressPointConfiguration;
/**
* A user friendly name for an ingress endpoint resource.
*/
IngressPointName: IngressPointName;
/**
* The identifier of an existing rule set that you attach to an ingress endpoint resource.
*/
RuleSetId: RuleSetId;
/**
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/
Tags?: TagList;
/**
* The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
*/
TrafficPolicyId: TrafficPolicyId;
/**
* The type of the ingress endpoint to create.
*/
Type: IngressPointType;
}
export interface CreateIngressPointResponse {
/**
* The unique identifier for a previously created ingress endpoint.
*/
IngressPointId: IngressPointId;
}
export interface CreateRelayRequest {
/**
* Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
*/
Authentication: RelayAuthentication;
/**
* A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*/
ClientToken?: IdempotencyToken;
/**
* The unique name of the relay resource.
*/
RelayName: RelayName;
/**
* The destination relay server address.
*/
ServerName: RelayServerName;
/**
* The destination relay server port.
*/
ServerPort: RelayServerPort;
/**
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/
Tags?: TagList;
}
export interface CreateRelayResponse {
/**
* A unique identifier of the created relay resource.
*/
RelayId: RelayId;
}
export interface CreateRuleSetRequest {
/**
* A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*/
ClientToken?: IdempotencyToken;
/**
* A user-friendly name for the rule set.
*/
RuleSetName: RuleSetName;
/**
* Conditional rules that are evaluated for determining actions on email.
*/
Rules: Rules;
/**
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/
Tags?: TagList;
}
export interface CreateRuleSetResponse {
/**
* The identifier of the created rule set.
*/
RuleSetId: RuleSetId;
}
export interface CreateTrafficPolicyRequest {
/**
* A unique token that Amazon SES uses to recognize subsequent retries of the same request.
*/
ClientToken?: IdempotencyToken;
/**
* Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
*/
DefaultAction: AcceptAction;
/**
* The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
*/
MaxMessageSizeBytes?: MaxMessageSizeBytes;
/**
* Conditional statements for filtering email traffic.
*/
PolicyStatements: PolicyStatementList;
/**
* The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/
Tags?: TagList;
/**
* A user-friendly name for the traffic policy resource.
*/
TrafficPolicyName: TrafficPolicyName;
}
export interface CreateTrafficPolicyResponse {
/**
* The identifier of the traffic policy resource.
*/
TrafficPolicyId: TrafficPolicyId;
}
export interface DeleteAddonInstanceRequest {
/**
* The Add On instance ID to delete.
*/
AddonInstanceId: AddonInstanceId;
}
export interface DeleteAddonInstanceResponse {
}
export interface DeleteAddonSubscriptionRequest {
/**
* The Add On subscription ID to delete.
*/
AddonSubscriptionId: AddonSubscriptionId;
}
export interface DeleteAddonSubscriptionResponse {
}
export interface DeleteArchiveRequest {
/**
* The identifier of the archive to delete.
*/
ArchiveId: ArchiveIdString;
}
export interface DeleteArchiveResponse {
}
export interface DeleteIngressPointRequest {
/**
* The identifier of the ingress endpoint resource that you want to delete.
*/
IngressPointId: IngressPointId;
}
export interface DeleteIngressPointResponse {
}
export interface DeleteRelayRequest {
/**
* The unique relay identifier.
*/
RelayId: RelayId;
}
export interface DeleteRelayResponse {
}
export interface DeleteRuleSetRequest {
/**
* The identifier of an existing rule set resource to delete.
*/
RuleSetId: RuleSetId;
}
export interface DeleteRuleSetResponse {
}
export interface DeleteTrafficPolicyRequest {
/**
* The identifier of the traffic policy that you want to delete.
*/
TrafficPolicyId: TrafficPolicyId;
}
export interface DeleteTrafficPolicyResponse {
}
export interface DeliverToMailboxAction {
/**
* A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.
*/
ActionFailurePolicy?: ActionFailurePolicy;
/**
* The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.
*/
MailboxArn: NameOrArn;
/**
* The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.
*/
RoleArn: IamRoleArn;
}
export type Double = number;
export interface DropAction {
}
export type EmailAddress = string;
export type EmailReceivedHeadersList = String[];
export type ErrorMessage = string;
export interface ExportDestinationConfiguration {
/**
* Configuration for delivering to an Amazon S3 bucket.
*/
S3?: S3ExportDestinationConfiguration;
}
export type ExportId = string;
export type ExportMaxResults = number;
export type ExportState = "QUEUED"|"PREPROCESSING"|"PROCESSING"|"COMPLETED"|"FAILED"|"CANCELLED"|string;
export interface ExportStatus {
/**
* The timestamp of when the export job completed (if finished).
*/
CompletionTimestamp?: Timestamp;
/**
* An error message if the export job failed.
*/
ErrorMessage?: ErrorMessage;
/**
* The current state of the export job.
*/
State?: ExportState;
/**
* The timestamp of when the export job was submitted.
*/
SubmissionTimestamp?: Timestamp;
}
export interface ExportSummary {
/**
* The unique identifier of the export job.
*/
ExportId?: ExportId;
/**
* The current status of the export job.
*/
Status?: ExportStatus;
}
export type ExportSummaryList = ExportSummary[];
export interface GetAddonInstanceRequest {
/**
* The Add On instance ID to retrieve information for.
*/
AddonInstanceId: AddonInstanceId;
}
export interface GetAddonInstanceResponse {
/**
* The Amazon Resource Name (ARN) of the Add On instance.
*/
AddonInstanceArn?: AddonInstanceArn;
/**
* The name of the Add On provider associated to the subscription of the instance.
*/
AddonName?: AddonName;
/**
* The subscription ID associated to the instance.
*/
AddonSubscriptionId?: AddonSubscriptionId;
/**
* The timestamp of when the Add On instance was created.
*/
CreatedTimestamp?: Timestamp;
}
export interface GetAddonSubscriptionRequest {
/**
* The Add On subscription ID to retrieve information for.
*/
AddonSubscriptionId: AddonSubscriptionId;
}
export interface GetAddonSubscriptionResponse {
/**
* The name of the Add On for the subscription.
*/
AddonName?: AddonName;
/**
* Amazon Resource Name (ARN) for the subscription.
*/
AddonSubscriptionArn?: AddonSubscriptionArn;
/**
* The timestamp of when the Add On subscription was created.
*/
CreatedTimestamp?: Timestamp;
}
export interface GetArchiveExportRequest {
/**
* The identifier of the export job to get details for.
*/
ExportId: ExportId;
}
export interface GetArchiveExportResponse {
/**
* The identifier of the archive the email export was performed from.
*/
ArchiveId?: ArchiveId;
/**
* Where the exported emails are being delivered.
*/
ExportDestinationConfiguration?: ExportDestinationConfiguration;
/**
* The criteria used to filter emails included in the export.
*/
Filters?: ArchiveFilters;
/**
* The start of the timestamp range the exported emails cover.
*/
FromTimestamp?: Timestamp;
/**
* The maximum number of email items included in the export.
*/
MaxResults?: ExportMaxResults;
/**
* The current status of the export job.
*/
Status?: ExportStatus;
/**
* The end of the date range the exported emails cover.
*/
ToTimestamp?: Timestamp;
}
export interface GetArchiveMessageContentRequest {
/**
* The unique identifier of the archived email message.
*/
ArchivedMessageId: ArchivedMessageId;
}
export interface GetArchiveMessageContentResponse {
/**
* The textual body content of the email message.
*/
Body?: MessageBody;
}
export interface GetArchiveMessageRequest {
/**
* The unique identifier of the archived email message.
*/
ArchivedMessageId: ArchivedMessageId;
}
export interface GetArchiveMessageResponse {
/**
* A pre-signed URL to temporarily download the full message content.
*/
MessageDownloadLink?: S3PresignedURL;
}
export interface GetArchiveRequest {
/**
* The identifier of the archive to retrieve.
*/
ArchiveId: ArchiveIdString;
}
export interface GetArchiveResponse {
/**
* The Amazon Resource Name (ARN) of the archive.
*/
ArchiveArn: ArchiveArn;
/**
* The unique identifier of the archive.
*/
ArchiveId: ArchiveIdString;
/**
* The unique name assigned to the archive.
*/
ArchiveName: ArchiveNameString;
/**
* The current state of the archive: ACTIVE – The archive is ready and available for use. PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
*/
ArchiveState: ArchiveState;
/**
* The timestamp of when the archive was created.
*/
CreatedTimestamp?: Timestamp;
/**
* The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
*/
KmsKeyArn?: KmsKeyArn;
/**
* The timestamp of when the archive was modified.
*/
LastUpdatedTimestamp?: Timestamp;
/**
* The retention period for emails in this archive.
*/
Retention: ArchiveRetention;
}
export interface GetArchiveSearchRequest {
/**
* The identifier of the search job to get details for.
*/
SearchId: SearchId;
}
export interface GetArchiveSearchResponse {
/**
* The identifier of the archive the email search was performed in.
*/
ArchiveId?: ArchiveId;
/**
* The criteria used to filter emails included in the search.
*/
Filters?: ArchiveFilters;
/**
* The start timestamp of the range the searched emails cover.
*/
FromTimestamp?: Timestamp;
/**
* The maximum number of search results to return.
*/
MaxResults?: SearchMaxResults;
/**
* The current status of the search job.
*/
Status?: SearchStatus;
/**
* The end timestamp of the range the searched emails cover.
*/
ToTimestamp?: Timestamp;
}
export interface GetArchiveSearchResultsRequest {
/**
* The identifier of the completed search job.
*/
SearchId: SearchId;
}
export interface GetArchiveSearchResultsResponse {
/**
* The list of email result objects matching the search criteria.
*/
Rows?: RowsList;
}
export interface GetIngressPointRequest {
/**
* The identifier of an ingress endpoint.
*/
IngressPointId: IngressPointId;
}
export interface GetIngressPointResponse {
/**
* The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
*/
ARecord?: IngressPointARecord;
/**
* The timestamp of when the ingress endpoint was created.
*/
CreatedTimestamp?: Timestamp;
/**
* The Amazon Resource Name (ARN) of the ingress endpoint resource.
*/
IngressPointArn?: IngressPointArn;
/**
* The authentication configuration of the ingress endpoint resource.
*/
IngressPointAuthConfiguration?: IngressPointAuthConfiguration;
/**
* The identifier of an ingress endpoint resource.
*/
IngressPointId: IngressPointId;
/**
* A user friendly name for the ingress endpoint.
*/
IngressPointName: IngressPointName;
/**
* The timestamp of when the ingress endpoint was last updated.
*/
LastUpdatedTimestamp?: Timestamp;
/**
* The identifier of a rule set resource associated with the ingress endpoint.
*/
RuleSetId?: RuleSetId;
/**
* The status of the ingress endpoint resource.
*/
Status?: IngressPointStatus;
/**
* The identifier of the traffic policy resource associated with the ingress endpoint.
*/
TrafficPolicyId?: TrafficPolicyId;
/**
* The type of ingress endpoint.
*/
Type?: IngressPointType;
}
export interface GetRelayRequest {
/**
* A unique relay identifier.
*/
RelayId: RelayId;
}
export interface GetRelayResponse {
/**
* The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.
*/
Authentication?: RelayAuthentication;
/**
* The timestamp of when the relay was created.
*/
CreatedTimestamp?: Timestamp;
/**
* The timestamp of when relay was last updated.
*/
LastModifiedTimestamp?: Timestamp;
/**
* The Amazon Resource Name (ARN) of the relay.
*/
RelayArn?: RelayArn;
/**
* The unique relay identifier.
*/
RelayId: RelayId;
/**
* The unique name of the relay.
*/
RelayName?: RelayName;
/**
* The destination relay server address.
*/
ServerName?: RelayServerName;
/**
* The destination relay server port.
*/
ServerPort?: RelayServerPort;
}
export interface GetRuleSetRequest {
/**
* The identifier of an existing rule set to be retrieved.
*/