com.amazonaws.services.mailmanager.AWSMailManager Maven / Gradle / Ivy
Show all versions of aws-java-sdk-mailmanager Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mailmanager;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.mailmanager.model.*;
/**
* Interface for accessing MailManager.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.mailmanager.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.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMailManager {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "mail-manager";
/**
*
* 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.
*
*
* @param createAddonInstanceRequest
* @return Result of the CreateAddonInstance operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.CreateAddonInstance
* @see AWS API Documentation
*/
CreateAddonInstanceResult createAddonInstance(CreateAddonInstanceRequest createAddonInstanceRequest);
/**
*
* 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.
*
*
* @param createAddonSubscriptionRequest
* @return Result of the CreateAddonSubscription operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.CreateAddonSubscription
* @see AWS API Documentation
*/
CreateAddonSubscriptionResult createAddonSubscription(CreateAddonSubscriptionRequest createAddonSubscriptionRequest);
/**
*
* Creates a new email archive resource for storing and retaining emails.
*
*
* @param createArchiveRequest
* The request to create a new email archive.
* @return Result of the CreateArchive operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.CreateArchive
* @see AWS API
* Documentation
*/
CreateArchiveResult createArchive(CreateArchiveRequest createArchiveRequest);
/**
*
* Provision a new ingress endpoint resource.
*
*
* @param createIngressPointRequest
* @return Result of the CreateIngressPoint operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.CreateIngressPoint
* @see AWS
* API Documentation
*/
CreateIngressPointResult createIngressPoint(CreateIngressPointRequest createIngressPointRequest);
/**
*
* Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
*
*
* @param createRelayRequest
* @return Result of the CreateRelay operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.CreateRelay
* @see AWS API
* Documentation
*/
CreateRelayResult createRelay(CreateRelayRequest createRelayRequest);
/**
*
* Provision a new rule set.
*
*
* @param createRuleSetRequest
* @return Result of the CreateRuleSet operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.CreateRuleSet
* @see AWS API
* Documentation
*/
CreateRuleSetResult createRuleSet(CreateRuleSetRequest createRuleSetRequest);
/**
*
* Provision a new traffic policy resource.
*
*
* @param createTrafficPolicyRequest
* @return Result of the CreateTrafficPolicy operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.CreateTrafficPolicy
* @see AWS API Documentation
*/
CreateTrafficPolicyResult createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest);
/**
*
* Deletes an Add On instance.
*
*
* @param deleteAddonInstanceRequest
* @return Result of the DeleteAddonInstance operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.DeleteAddonInstance
* @see AWS API Documentation
*/
DeleteAddonInstanceResult deleteAddonInstance(DeleteAddonInstanceRequest deleteAddonInstanceRequest);
/**
*
* Deletes an Add On subscription.
*
*
* @param deleteAddonSubscriptionRequest
* @return Result of the DeleteAddonSubscription operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.DeleteAddonSubscription
* @see AWS API Documentation
*/
DeleteAddonSubscriptionResult deleteAddonSubscription(DeleteAddonSubscriptionRequest deleteAddonSubscriptionRequest);
/**
*
* 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.
*
*
* @param deleteArchiveRequest
* The request to initiate deletion of an email archive.
* @return Result of the DeleteArchive operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.DeleteArchive
* @see AWS API
* Documentation
*/
DeleteArchiveResult deleteArchive(DeleteArchiveRequest deleteArchiveRequest);
/**
*
* Delete an ingress endpoint resource.
*
*
* @param deleteIngressPointRequest
* @return Result of the DeleteIngressPoint operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.DeleteIngressPoint
* @see AWS
* API Documentation
*/
DeleteIngressPointResult deleteIngressPoint(DeleteIngressPointRequest deleteIngressPointRequest);
/**
*
* Deletes an existing relay resource.
*
*
* @param deleteRelayRequest
* @return Result of the DeleteRelay operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.DeleteRelay
* @see AWS API
* Documentation
*/
DeleteRelayResult deleteRelay(DeleteRelayRequest deleteRelayRequest);
/**
*
* Delete a rule set.
*
*
* @param deleteRuleSetRequest
* @return Result of the DeleteRuleSet operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AWSMailManager.DeleteRuleSet
* @see AWS API
* Documentation
*/
DeleteRuleSetResult deleteRuleSet(DeleteRuleSetRequest deleteRuleSetRequest);
/**
*
* Delete a traffic policy resource.
*
*
* @param deleteTrafficPolicyRequest
* @return Result of the DeleteTrafficPolicy operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.DeleteTrafficPolicy
* @see AWS API Documentation
*/
DeleteTrafficPolicyResult deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest);
/**
*
* Gets detailed information about an Add On instance.
*
*
* @param getAddonInstanceRequest
* @return Result of the GetAddonInstance operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.GetAddonInstance
* @see AWS
* API Documentation
*/
GetAddonInstanceResult getAddonInstance(GetAddonInstanceRequest getAddonInstanceRequest);
/**
*
* Gets detailed information about an Add On subscription.
*
*
* @param getAddonSubscriptionRequest
* @return Result of the GetAddonSubscription operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.GetAddonSubscription
* @see AWS API Documentation
*/
GetAddonSubscriptionResult getAddonSubscription(GetAddonSubscriptionRequest getAddonSubscriptionRequest);
/**
*
* Retrieves the full details and current state of a specified email archive.
*
*
* @param getArchiveRequest
* The request to retrieve details of an email archive.
* @return Result of the GetArchive operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.GetArchive
* @see AWS API
* Documentation
*/
GetArchiveResult getArchive(GetArchiveRequest getArchiveRequest);
/**
*
* Retrieves the details and current status of a specific email archive export job.
*
*
* @param getArchiveExportRequest
* The request to retrieve details of a specific archive export job.
* @return Result of the GetArchiveExport operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.GetArchiveExport
* @see AWS
* API Documentation
*/
GetArchiveExportResult getArchiveExport(GetArchiveExportRequest getArchiveExportRequest);
/**
*
* Returns a pre-signed URL that provides temporary download access to the specific email message stored in the
* archive.
*
*
* @param getArchiveMessageRequest
* The request to get details of a specific email message stored in an archive.
* @return Result of the GetArchiveMessage operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.GetArchiveMessage
* @see AWS
* API Documentation
*/
GetArchiveMessageResult getArchiveMessage(GetArchiveMessageRequest getArchiveMessageRequest);
/**
*
* Returns the textual content of a specific email message stored in the archive. Attachments are not included.
*
*
* @param getArchiveMessageContentRequest
* The request to get the textual content of a specific email message stored in an archive.
* @return Result of the GetArchiveMessageContent operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.GetArchiveMessageContent
* @see AWS API Documentation
*/
GetArchiveMessageContentResult getArchiveMessageContent(GetArchiveMessageContentRequest getArchiveMessageContentRequest);
/**
*
* Retrieves the details and current status of a specific email archive search job.
*
*
* @param getArchiveSearchRequest
* The request to retrieve details of a specific archive search job.
* @return Result of the GetArchiveSearch operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.GetArchiveSearch
* @see AWS
* API Documentation
*/
GetArchiveSearchResult getArchiveSearch(GetArchiveSearchRequest getArchiveSearchRequest);
/**
*
* Returns the results of a completed email archive search job.
*
*
* @param getArchiveSearchResultsRequest
* The request to retrieve results from a completed archive search job.
* @return Result of the GetArchiveSearchResults operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.GetArchiveSearchResults
* @see AWS API Documentation
*/
GetArchiveSearchResultsResult getArchiveSearchResults(GetArchiveSearchResultsRequest getArchiveSearchResultsRequest);
/**
*
* Fetch ingress endpoint resource attributes.
*
*
* @param getIngressPointRequest
* @return Result of the GetIngressPoint operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.GetIngressPoint
* @see AWS
* API Documentation
*/
GetIngressPointResult getIngressPoint(GetIngressPointRequest getIngressPointRequest);
/**
*
* Fetch the relay resource and it's attributes.
*
*
* @param getRelayRequest
* @return Result of the GetRelay operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.GetRelay
* @see AWS API
* Documentation
*/
GetRelayResult getRelay(GetRelayRequest getRelayRequest);
/**
*
* Fetch attributes of a rule set.
*
*
* @param getRuleSetRequest
* @return Result of the GetRuleSet operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.GetRuleSet
* @see AWS API
* Documentation
*/
GetRuleSetResult getRuleSet(GetRuleSetRequest getRuleSetRequest);
/**
*
* Fetch attributes of a traffic policy resource.
*
*
* @param getTrafficPolicyRequest
* @return Result of the GetTrafficPolicy operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.GetTrafficPolicy
* @see AWS
* API Documentation
*/
GetTrafficPolicyResult getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest);
/**
*
* Lists all Add On instances in your account.
*
*
* @param listAddonInstancesRequest
* @return Result of the ListAddonInstances operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @sample AWSMailManager.ListAddonInstances
* @see AWS
* API Documentation
*/
ListAddonInstancesResult listAddonInstances(ListAddonInstancesRequest listAddonInstancesRequest);
/**
*
* Lists all Add On subscriptions in your account.
*
*
* @param listAddonSubscriptionsRequest
* @return Result of the ListAddonSubscriptions operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @sample AWSMailManager.ListAddonSubscriptions
* @see AWS API Documentation
*/
ListAddonSubscriptionsResult listAddonSubscriptions(ListAddonSubscriptionsRequest listAddonSubscriptionsRequest);
/**
*
* Returns a list of email archive export jobs.
*
*
* @param listArchiveExportsRequest
* The request to list archive export jobs in your account.
* @return Result of the ListArchiveExports operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.ListArchiveExports
* @see AWS
* API Documentation
*/
ListArchiveExportsResult listArchiveExports(ListArchiveExportsRequest listArchiveExportsRequest);
/**
*
* Returns a list of email archive search jobs.
*
*
* @param listArchiveSearchesRequest
* The request to list archive search jobs in your account.
* @return Result of the ListArchiveSearches operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.ListArchiveSearches
* @see AWS API Documentation
*/
ListArchiveSearchesResult listArchiveSearches(ListArchiveSearchesRequest listArchiveSearchesRequest);
/**
*
* Returns a list of all email archives in your account.
*
*
* @param listArchivesRequest
* The request to list email archives in your account.
* @return Result of the ListArchives operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.ListArchives
* @see AWS API
* Documentation
*/
ListArchivesResult listArchives(ListArchivesRequest listArchivesRequest);
/**
*
* List all ingress endpoint resources.
*
*
* @param listIngressPointsRequest
* @return Result of the ListIngressPoints operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @sample AWSMailManager.ListIngressPoints
* @see AWS
* API Documentation
*/
ListIngressPointsResult listIngressPoints(ListIngressPointsRequest listIngressPointsRequest);
/**
*
* Lists all the existing relay resources.
*
*
* @param listRelaysRequest
* @return Result of the ListRelays operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @sample AWSMailManager.ListRelays
* @see AWS API
* Documentation
*/
ListRelaysResult listRelays(ListRelaysRequest listRelaysRequest);
/**
*
* List rule sets for this account.
*
*
* @param listRuleSetsRequest
* @return Result of the ListRuleSets operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @sample AWSMailManager.ListRuleSets
* @see AWS API
* Documentation
*/
ListRuleSetsResult listRuleSets(ListRuleSetsRequest listRuleSetsRequest);
/**
*
* Retrieves the list of tags (keys and values) assigned to the resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* List traffic policy resources.
*
*
* @param listTrafficPoliciesRequest
* @return Result of the ListTrafficPolicies operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @sample AWSMailManager.ListTrafficPolicies
* @see AWS API Documentation
*/
ListTrafficPoliciesResult listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest);
/**
*
* Initiates an export of emails from the specified archive.
*
*
* @param startArchiveExportRequest
* The request to initiate an export of emails from an archive.
* @return Result of the StartArchiveExport operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.StartArchiveExport
* @see AWS
* API Documentation
*/
StartArchiveExportResult startArchiveExport(StartArchiveExportRequest startArchiveExportRequest);
/**
*
* Initiates a search across emails in the specified archive.
*
*
* @param startArchiveSearchRequest
* The request to initiate a search across emails in an archive.
* @return Result of the StartArchiveSearch operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.StartArchiveSearch
* @see AWS
* API Documentation
*/
StartArchiveSearchResult startArchiveSearch(StartArchiveSearchRequest startArchiveSearchRequest);
/**
*
* Stops an in-progress export of emails from an archive.
*
*
* @param stopArchiveExportRequest
* The request to stop an in-progress archive export job.
* @return Result of the StopArchiveExport operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.StopArchiveExport
* @see AWS
* API Documentation
*/
StopArchiveExportResult stopArchiveExport(StopArchiveExportRequest stopArchiveExportRequest);
/**
*
* Stops an in-progress archive search job.
*
*
* @param stopArchiveSearchRequest
* The request to stop an in-progress archive search job.
* @return Result of the StopArchiveSearch operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.StopArchiveSearch
* @see AWS
* API Documentation
*/
StopArchiveSearchResult stopArchiveSearch(StopArchiveSearchRequest stopArchiveSearchRequest);
/**
*
* Adds one or more tags (keys and values) to a specified resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Remove one or more tags (keys and values) from a specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the attributes of an existing email archive.
*
*
* @param updateArchiveRequest
* The request to update properties of an existing email archive.
* @return Result of the UpdateArchive operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws AccessDeniedException
* Occurs when a user is denied access to a specific resource or action.
* @throws ServiceQuotaExceededException
* Occurs when an operation exceeds a predefined service quota or limit.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @throws ThrottlingException
* Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
* @sample AWSMailManager.UpdateArchive
* @see AWS API
* Documentation
*/
UpdateArchiveResult updateArchive(UpdateArchiveRequest updateArchiveRequest);
/**
*
* Update attributes of a provisioned ingress endpoint resource.
*
*
* @param updateIngressPointRequest
* @return Result of the UpdateIngressPoint operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.UpdateIngressPoint
* @see AWS
* API Documentation
*/
UpdateIngressPointResult updateIngressPoint(UpdateIngressPointRequest updateIngressPointRequest);
/**
*
* Updates the attributes of an existing relay resource.
*
*
* @param updateRelayRequest
* @return Result of the UpdateRelay operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.UpdateRelay
* @see AWS API
* Documentation
*/
UpdateRelayResult updateRelay(UpdateRelayRequest updateRelayRequest);
/**
*
* >Update attributes of an already provisioned rule set.
*
*
* @param updateRuleSetRequest
* @return Result of the UpdateRuleSet operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.UpdateRuleSet
* @see AWS API
* Documentation
*/
UpdateRuleSetResult updateRuleSet(UpdateRuleSetRequest updateRuleSetRequest);
/**
*
* Update attributes of an already provisioned traffic policy resource.
*
*
* @param updateTrafficPolicyRequest
* @return Result of the UpdateTrafficPolicy operation returned by the service.
* @throws ValidationException
* The request validation has failed. For details, see the accompanying error message.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws ResourceNotFoundException
* Occurs when a requested resource is not found.
* @sample AWSMailManager.UpdateTrafficPolicy
* @see AWS API Documentation
*/
UpdateTrafficPolicyResult updateTrafficPolicy(UpdateTrafficPolicyRequest updateTrafficPolicyRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}