com.amazonaws.services.workmailmessageflow

Class AmazonWorkMailMessageFlowClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.workmailmessageflow.AmazonWorkMailMessageFlowClient

All Implemented Interfaces:

AmazonWorkMailMessageFlow

Direct Known Subclasses:

AmazonWorkMailMessageFlowAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonWorkMailMessageFlowClient
extends AmazonWebServiceClient
implements AmazonWorkMailMessageFlow

Client for accessing Amazon WorkMail Message Flow. All service calls made using this client are blocking, and will not return until the service call completes.

The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.workmailmessageflow.AmazonWorkMailMessageFlow

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonWorkMailMessageFlowClientBuilder	builder()
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.
GetRawMessageContentResult	getRawMessageContent(GetRawMessageContentRequest request) Retrieves the raw content of an in-transit email message, in MIME format.
PutRawMessageContentResult	putRawMessageContent(PutRawMessageContentRequest request) Updates the raw content of an in-transit email message, in MIME format.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonWorkMailMessageFlowClientBuilder builder()

getRawMessageContent

public GetRawMessageContentResult getRawMessageContent(GetRawMessageContentRequest request)

Retrieves the raw content of an in-transit email message, in MIME format.

Specified by:

getRawMessageContent in interface AmazonWorkMailMessageFlow

Parameters:

getRawMessageContentRequest -

Returns:

Result of the GetRawMessageContent operation returned by the service.

Throws:

ResourceNotFoundException - The requested email message is not found.

See Also:

AWS API Documentation

putRawMessageContent

public PutRawMessageContentResult putRawMessageContent(PutRawMessageContentRequest request)

Updates the raw content of an in-transit email message, in MIME format.

This example describes how to update in-transit email message. For more information and examples for using this API, see Updating message content with AWS Lambda.

Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function configured with a synchronous Run Lambda rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, even though GetRawMessageContent returns an updated message.

Specified by:

putRawMessageContent in interface AmazonWorkMailMessageFlow

Parameters:

putRawMessageContentRequest -

Returns:

Result of the PutRawMessageContent operation returned by the service.

Throws:

ResourceNotFoundException - The requested email message is not found.

InvalidContentLocationException - WorkMail could not access the updated email content. Possible reasons:

• You made the request in a region other than your S3 bucket region.

• The S3 bucket owner is not the same as the calling AWS account.

• You have an incomplete or missing S3 bucket policy. For more information about policies, see Updating message content with AWS Lambda in the WorkMail Administrator Guide.

MessageRejectedException - The requested email could not be updated due to an error in the MIME content. Check the error message for more information about what caused the error.

MessageFrozenException - The requested email is not eligible for update. This is usually the case for a redirected email.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonWorkMailMessageFlow

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AmazonWorkMailMessageFlow

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.

Specified by:

shutdown in interface AmazonWorkMailMessageFlow

Overrides:

shutdown in class AmazonWebServiceClient