com.amazonaws.services.mailmanager

Interface AWSMailManager

All Known Subinterfaces:

AWSMailManagerAsync

All Known Implementing Classes:

AbstractAWSMailManager, AbstractAWSMailManagerAsync, AWSMailManagerAsyncClient, AWSMailManagerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMailManager

Interface for accessing MailManager.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMailManager instead.

AWS SES Mail Manager API

AWS SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service.

Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapter in the Amazon SES Developer Guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAddonInstanceResult	createAddonInstance(CreateAddonInstanceRequest createAddonInstanceRequest) Creates an Add On instance for the subscription indicated in the request.
CreateAddonSubscriptionResult	createAddonSubscription(CreateAddonSubscriptionRequest createAddonSubscriptionRequest) Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing.
CreateArchiveResult	createArchive(CreateArchiveRequest createArchiveRequest) Creates a new email archive resource for storing and retaining emails.
CreateIngressPointResult	createIngressPoint(CreateIngressPointRequest createIngressPointRequest) Provision a new ingress endpoint resource.
CreateRelayResult	createRelay(CreateRelayRequest createRelayRequest) Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
CreateRuleSetResult	createRuleSet(CreateRuleSetRequest createRuleSetRequest) Provision a new rule set.
CreateTrafficPolicyResult	createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest) Provision a new traffic policy resource.
DeleteAddonInstanceResult	deleteAddonInstance(DeleteAddonInstanceRequest deleteAddonInstanceRequest) Deletes an Add On instance.
DeleteAddonSubscriptionResult	deleteAddonSubscription(DeleteAddonSubscriptionRequest deleteAddonSubscriptionRequest) Deletes an Add On subscription.
DeleteArchiveResult	deleteArchive(DeleteArchiveRequest deleteArchiveRequest) Initiates deletion of an email archive.
DeleteIngressPointResult	deleteIngressPoint(DeleteIngressPointRequest deleteIngressPointRequest) Delete an ingress endpoint resource.
DeleteRelayResult	deleteRelay(DeleteRelayRequest deleteRelayRequest) Deletes an existing relay resource.
DeleteRuleSetResult	deleteRuleSet(DeleteRuleSetRequest deleteRuleSetRequest) Delete a rule set.
DeleteTrafficPolicyResult	deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest) Delete a traffic policy resource.
GetAddonInstanceResult	getAddonInstance(GetAddonInstanceRequest getAddonInstanceRequest) Gets detailed information about an Add On instance.
GetAddonSubscriptionResult	getAddonSubscription(GetAddonSubscriptionRequest getAddonSubscriptionRequest) Gets detailed information about an Add On subscription.
GetArchiveResult	getArchive(GetArchiveRequest getArchiveRequest) Retrieves the full details and current state of a specified email archive.
GetArchiveExportResult	getArchiveExport(GetArchiveExportRequest getArchiveExportRequest) Retrieves the details and current status of a specific email archive export job.
GetArchiveMessageResult	getArchiveMessage(GetArchiveMessageRequest getArchiveMessageRequest) Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
GetArchiveMessageContentResult	getArchiveMessageContent(GetArchiveMessageContentRequest getArchiveMessageContentRequest) Returns the textual content of a specific email message stored in the archive.
GetArchiveSearchResult	getArchiveSearch(GetArchiveSearchRequest getArchiveSearchRequest) Retrieves the details and current status of a specific email archive search job.
GetArchiveSearchResultsResult	getArchiveSearchResults(GetArchiveSearchResultsRequest getArchiveSearchResultsRequest) Returns the results of a completed email archive search job.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetIngressPointResult	getIngressPoint(GetIngressPointRequest getIngressPointRequest) Fetch ingress endpoint resource attributes.
GetRelayResult	getRelay(GetRelayRequest getRelayRequest) Fetch the relay resource and it's attributes.
GetRuleSetResult	getRuleSet(GetRuleSetRequest getRuleSetRequest) Fetch attributes of a rule set.
GetTrafficPolicyResult	getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest) Fetch attributes of a traffic policy resource.
ListAddonInstancesResult	listAddonInstances(ListAddonInstancesRequest listAddonInstancesRequest) Lists all Add On instances in your account.
ListAddonSubscriptionsResult	listAddonSubscriptions(ListAddonSubscriptionsRequest listAddonSubscriptionsRequest) Lists all Add On subscriptions in your account.
ListArchiveExportsResult	listArchiveExports(ListArchiveExportsRequest listArchiveExportsRequest) Returns a list of email archive export jobs.
ListArchivesResult	listArchives(ListArchivesRequest listArchivesRequest) Returns a list of all email archives in your account.
ListArchiveSearchesResult	listArchiveSearches(ListArchiveSearchesRequest listArchiveSearchesRequest) Returns a list of email archive search jobs.
ListIngressPointsResult	listIngressPoints(ListIngressPointsRequest listIngressPointsRequest) List all ingress endpoint resources.
ListRelaysResult	listRelays(ListRelaysRequest listRelaysRequest) Lists all the existing relay resources.
ListRuleSetsResult	listRuleSets(ListRuleSetsRequest listRuleSetsRequest) List rule sets for this account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags (keys and values) assigned to the resource.
ListTrafficPoliciesResult	listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest) List traffic policy resources.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartArchiveExportResult	startArchiveExport(StartArchiveExportRequest startArchiveExportRequest) Initiates an export of emails from the specified archive.
StartArchiveSearchResult	startArchiveSearch(StartArchiveSearchRequest startArchiveSearchRequest) Initiates a search across emails in the specified archive.
StopArchiveExportResult	stopArchiveExport(StopArchiveExportRequest stopArchiveExportRequest) Stops an in-progress export of emails from an archive.
StopArchiveSearchResult	stopArchiveSearch(StopArchiveSearchRequest stopArchiveSearchRequest) Stops an in-progress archive search job.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags (keys and values) to a specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.
UpdateArchiveResult	updateArchive(UpdateArchiveRequest updateArchiveRequest) Updates the attributes of an existing email archive.
UpdateIngressPointResult	updateIngressPoint(UpdateIngressPointRequest updateIngressPointRequest) Update attributes of a provisioned ingress endpoint resource.
UpdateRelayResult	updateRelay(UpdateRelayRequest updateRelayRequest) Updates the attributes of an existing relay resource.
UpdateRuleSetResult	updateRuleSet(UpdateRuleSetRequest updateRuleSetRequest) >Update attributes of an already provisioned rule set.
UpdateTrafficPolicyResult	updateTrafficPolicy(UpdateTrafficPolicyRequest updateTrafficPolicyRequest) Update attributes of an already provisioned traffic policy resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createAddonInstance

CreateAddonInstanceResult createAddonInstance(CreateAddonInstanceRequest createAddonInstanceRequest)

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.

Parameters:

createAddonInstanceRequest -

Returns:

Result of the CreateAddonInstance operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

createAddonSubscription

CreateAddonSubscriptionResult createAddonSubscription(CreateAddonSubscriptionRequest createAddonSubscriptionRequest)

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.

Parameters:

createAddonSubscriptionRequest -

Returns:

Result of the CreateAddonSubscription operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

createArchive

CreateArchiveResult createArchive(CreateArchiveRequest createArchiveRequest)

Creates a new email archive resource for storing and retaining emails.

Parameters:

createArchiveRequest - The request to create a new email archive.

Returns:

Result of the CreateArchive operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

createIngressPoint

CreateIngressPointResult createIngressPoint(CreateIngressPointRequest createIngressPointRequest)

Provision a new ingress endpoint resource.

Parameters:

createIngressPointRequest -

Returns:

Result of the CreateIngressPoint operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

createRelay

CreateRelayResult createRelay(CreateRelayRequest createRelayRequest)

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

Parameters:

createRelayRequest -

Returns:

Result of the CreateRelay operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

createRuleSet

CreateRuleSetResult createRuleSet(CreateRuleSetRequest createRuleSetRequest)

Provision a new rule set.

Parameters:

createRuleSetRequest -

Returns:

Result of the CreateRuleSet operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

createTrafficPolicy

CreateTrafficPolicyResult createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest)

Provision a new traffic policy resource.

Parameters:

createTrafficPolicyRequest -

Returns:

Result of the CreateTrafficPolicy operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

deleteAddonInstance

DeleteAddonInstanceResult deleteAddonInstance(DeleteAddonInstanceRequest deleteAddonInstanceRequest)

Deletes an Add On instance.

Parameters:

deleteAddonInstanceRequest -

Returns:

Result of the DeleteAddonInstance operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

deleteAddonSubscription

DeleteAddonSubscriptionResult deleteAddonSubscription(DeleteAddonSubscriptionRequest deleteAddonSubscriptionRequest)

Deletes an Add On subscription.

Parameters:

deleteAddonSubscriptionRequest -

Returns:

Result of the DeleteAddonSubscription operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

deleteArchive

DeleteArchiveResult deleteArchive(DeleteArchiveRequest deleteArchiveRequest)

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.

Parameters:

deleteArchiveRequest - The request to initiate deletion of an email archive.

Returns:

Result of the DeleteArchive operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

deleteIngressPoint

DeleteIngressPointResult deleteIngressPoint(DeleteIngressPointRequest deleteIngressPointRequest)

Delete an ingress endpoint resource.

Parameters:

deleteIngressPointRequest -

Returns:

Result of the DeleteIngressPoint operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

deleteRelay

DeleteRelayResult deleteRelay(DeleteRelayRequest deleteRelayRequest)

Deletes an existing relay resource.

Parameters:

deleteRelayRequest -

Returns:

Result of the DeleteRelay operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

deleteRuleSet

DeleteRuleSetResult deleteRuleSet(DeleteRuleSetRequest deleteRuleSetRequest)

Delete a rule set.

Parameters:

deleteRuleSetRequest -

Returns:

Result of the DeleteRuleSet operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

See Also:

AWS API Documentation

deleteTrafficPolicy

DeleteTrafficPolicyResult deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest)

Delete a traffic policy resource.

Parameters:

deleteTrafficPolicyRequest -

Returns:

Result of the DeleteTrafficPolicy operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

getAddonInstance

GetAddonInstanceResult getAddonInstance(GetAddonInstanceRequest getAddonInstanceRequest)

Gets detailed information about an Add On instance.

Parameters:

getAddonInstanceRequest -

Returns:

Result of the GetAddonInstance operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

getAddonSubscription

GetAddonSubscriptionResult getAddonSubscription(GetAddonSubscriptionRequest getAddonSubscriptionRequest)

Gets detailed information about an Add On subscription.

Parameters:

getAddonSubscriptionRequest -

Returns:

Result of the GetAddonSubscription operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

getArchive

GetArchiveResult getArchive(GetArchiveRequest getArchiveRequest)

Retrieves the full details and current state of a specified email archive.

Parameters:

getArchiveRequest - The request to retrieve details of an email archive.

Returns:

Result of the GetArchive operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ResourceNotFoundException - Occurs when a requested resource is not found.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

getArchiveExport

GetArchiveExportResult getArchiveExport(GetArchiveExportRequest getArchiveExportRequest)

Retrieves the details and current status of a specific email archive export job.

Parameters:

getArchiveExportRequest - The request to retrieve details of a specific archive export job.

Returns:

Result of the GetArchiveExport operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

getArchiveMessage

GetArchiveMessageResult getArchiveMessage(GetArchiveMessageRequest getArchiveMessageRequest)

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

Parameters:

getArchiveMessageRequest - The request to get details of a specific email message stored in an archive.

Returns:

Result of the GetArchiveMessage operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

getArchiveMessageContent

GetArchiveMessageContentResult getArchiveMessageContent(GetArchiveMessageContentRequest getArchiveMessageContentRequest)

Returns the textual content of a specific email message stored in the archive. Attachments are not included.

Parameters:

getArchiveMessageContentRequest - The request to get the textual content of a specific email message stored in an archive.

Returns:

Result of the GetArchiveMessageContent operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

getArchiveSearch

GetArchiveSearchResult getArchiveSearch(GetArchiveSearchRequest getArchiveSearchRequest)

Retrieves the details and current status of a specific email archive search job.

Parameters:

getArchiveSearchRequest - The request to retrieve details of a specific archive search job.

Returns:

Result of the GetArchiveSearch operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

getArchiveSearchResults

GetArchiveSearchResultsResult getArchiveSearchResults(GetArchiveSearchResultsRequest getArchiveSearchResultsRequest)

Returns the results of a completed email archive search job.

Parameters:

getArchiveSearchResultsRequest - The request to retrieve results from a completed archive search job.

Returns:

Result of the GetArchiveSearchResults operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

getIngressPoint

GetIngressPointResult getIngressPoint(GetIngressPointRequest getIngressPointRequest)

Fetch ingress endpoint resource attributes.

Parameters:

getIngressPointRequest -

Returns:

Result of the GetIngressPoint operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

getRelay

GetRelayResult getRelay(GetRelayRequest getRelayRequest)

Fetch the relay resource and it's attributes.

Parameters:

getRelayRequest -

Returns:

Result of the GetRelay operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

getRuleSet

GetRuleSetResult getRuleSet(GetRuleSetRequest getRuleSetRequest)

Fetch attributes of a rule set.

Parameters:

getRuleSetRequest -

Returns:

Result of the GetRuleSet operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

getTrafficPolicy

GetTrafficPolicyResult getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest)

Fetch attributes of a traffic policy resource.

Parameters:

getTrafficPolicyRequest -

Returns:

Result of the GetTrafficPolicy operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

listAddonInstances

ListAddonInstancesResult listAddonInstances(ListAddonInstancesRequest listAddonInstancesRequest)

Lists all Add On instances in your account.

Parameters:

listAddonInstancesRequest -

Returns:

Result of the ListAddonInstances operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

See Also:

AWS API Documentation

listAddonSubscriptions

ListAddonSubscriptionsResult listAddonSubscriptions(ListAddonSubscriptionsRequest listAddonSubscriptionsRequest)

Lists all Add On subscriptions in your account.

Parameters:

listAddonSubscriptionsRequest -

Returns:

Result of the ListAddonSubscriptions operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

See Also:

AWS API Documentation

listArchiveExports

ListArchiveExportsResult listArchiveExports(ListArchiveExportsRequest listArchiveExportsRequest)

Returns a list of email archive export jobs.

Parameters:

listArchiveExportsRequest - The request to list archive export jobs in your account.

Returns:

Result of the ListArchiveExports operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ResourceNotFoundException - Occurs when a requested resource is not found.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

listArchiveSearches

ListArchiveSearchesResult listArchiveSearches(ListArchiveSearchesRequest listArchiveSearchesRequest)

Returns a list of email archive search jobs.

Parameters:

listArchiveSearchesRequest - The request to list archive search jobs in your account.

Returns:

Result of the ListArchiveSearches operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ResourceNotFoundException - Occurs when a requested resource is not found.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

listArchives

ListArchivesResult listArchives(ListArchivesRequest listArchivesRequest)

Returns a list of all email archives in your account.

Parameters:

listArchivesRequest - The request to list email archives in your account.

Returns:

Result of the ListArchives operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

listIngressPoints

ListIngressPointsResult listIngressPoints(ListIngressPointsRequest listIngressPointsRequest)

List all ingress endpoint resources.

Parameters:

listIngressPointsRequest -

Returns:

Result of the ListIngressPoints operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

See Also:

AWS API Documentation

listRelays

ListRelaysResult listRelays(ListRelaysRequest listRelaysRequest)

Lists all the existing relay resources.

Parameters:

listRelaysRequest -

Returns:

Result of the ListRelays operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

See Also:

AWS API Documentation

listRuleSets

ListRuleSetsResult listRuleSets(ListRuleSetsRequest listRuleSetsRequest)

List rule sets for this account.

Parameters:

listRuleSetsRequest -

Returns:

Result of the ListRuleSets operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Retrieves the list of tags (keys and values) assigned to the resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

listTrafficPolicies

ListTrafficPoliciesResult listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest)

List traffic policy resources.

Parameters:

listTrafficPoliciesRequest -

Returns:

Result of the ListTrafficPolicies operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

See Also:

AWS API Documentation

startArchiveExport

StartArchiveExportResult startArchiveExport(StartArchiveExportRequest startArchiveExportRequest)

Initiates an export of emails from the specified archive.

Parameters:

startArchiveExportRequest - The request to initiate an export of emails from an archive.

Returns:

Result of the StartArchiveExport operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ResourceNotFoundException - Occurs when a requested resource is not found.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

startArchiveSearch

StartArchiveSearchResult startArchiveSearch(StartArchiveSearchRequest startArchiveSearchRequest)

Initiates a search across emails in the specified archive.

Parameters:

startArchiveSearchRequest - The request to initiate a search across emails in an archive.

Returns:

Result of the StartArchiveSearch operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

stopArchiveExport

StopArchiveExportResult stopArchiveExport(StopArchiveExportRequest stopArchiveExportRequest)

Stops an in-progress export of emails from an archive.

Parameters:

stopArchiveExportRequest - The request to stop an in-progress archive export job.

Returns:

Result of the StopArchiveExport operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

stopArchiveSearch

StopArchiveSearchResult stopArchiveSearch(StopArchiveSearchRequest stopArchiveSearchRequest)

Stops an in-progress archive search job.

Parameters:

stopArchiveSearchRequest - The request to stop an in-progress archive search job.

Returns:

Result of the StopArchiveSearch operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds one or more tags (keys and values) to a specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Remove one or more tags (keys and values) from a specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

updateArchive

UpdateArchiveResult updateArchive(UpdateArchiveRequest updateArchiveRequest)

Updates the attributes of an existing email archive.

Parameters:

updateArchiveRequest - The request to update properties of an existing email archive.

Returns:

Result of the UpdateArchive operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

AccessDeniedException - Occurs when a user is denied access to a specific resource or action.

ServiceQuotaExceededException - Occurs when an operation exceeds a predefined service quota or limit.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

ThrottlingException - Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

See Also:

AWS API Documentation

updateIngressPoint

UpdateIngressPointResult updateIngressPoint(UpdateIngressPointRequest updateIngressPointRequest)

Update attributes of a provisioned ingress endpoint resource.

Parameters:

updateIngressPointRequest -

Returns:

Result of the UpdateIngressPoint operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

updateRelay

UpdateRelayResult updateRelay(UpdateRelayRequest updateRelayRequest)

Updates the attributes of an existing relay resource.

Parameters:

updateRelayRequest -

Returns:

Result of the UpdateRelay operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

updateRuleSet

UpdateRuleSetResult updateRuleSet(UpdateRuleSetRequest updateRuleSetRequest)

>Update attributes of an already provisioned rule set.

Parameters:

updateRuleSetRequest -

Returns:

Result of the UpdateRuleSet operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

updateTrafficPolicy

UpdateTrafficPolicyResult updateTrafficPolicy(UpdateTrafficPolicyRequest updateTrafficPolicyRequest)

Update attributes of an already provisioned traffic policy resource.

Parameters:

updateTrafficPolicyRequest -

Returns:

Result of the UpdateTrafficPolicy operation returned by the service.

Throws:

ValidationException - The request validation has failed. For details, see the accompanying error message.

ConflictException - The request configuration has conflicts. For details, see the accompanying error message.

ResourceNotFoundException - Occurs when a requested resource is not found.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.