WorkMailMessageFlow

Table of Contents

• WorkMailMessageFlow
  • Client
  • Client Exceptions
  • Paginators

Client

class WorkMailMessageFlow.Client

A low-level client representing Amazon WorkMail Message Flow:

client = session.create_client('workmailmessageflow')

These are the available methods:

• can_paginate()
• generate_presigned_url()
• get_paginator()
• get_raw_message_content()
• get_waiter()

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Returns

True if the operation can be paginated, False otherwise.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters

• ClientMethod (string) -- The client method to presign for
• Params (dict) -- The parameters normally passed to ClientMethod.
• ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
• HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Raises OperationNotPageableError

Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.

Return type

L{botocore.paginate.Paginator}

Returns

A paginator object.

get_raw_message_content(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_raw_message_content(
    messageId='string'
)

Parameters

messageId (string) --

[REQUIRED]

The identifier of the email message to retrieve.

Return type

dict

Returns

Response Syntax

{
    'messageContent': StreamingBody()
}

Response Structure

• (dict) --
  • messageContent (StreamingBody) --

    The raw content of the email message, in MIME format.

Exceptions

• WorkMailMessageFlow.Client.exceptions.ResourceNotFoundException

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters

waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.

Returns

The specified waiter object.

Return type

botocore.waiter.Waiter

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

• WorkMailMessageFlow.Client.exceptions.ResourceNotFoundException

class WorkMailMessageFlow.Client.exceptions.ResourceNotFoundException

The requested email message is not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)

response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

• (dict) --

  The requested email message is not found.

  • message (string) --
  • Error (dict) -- Normalized access to common exception attributes.
    • Code (string) -- An identifier specifying the exception type.
    • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: