WorkMailMessageFlow
*******************


Client
======

class WorkMailMessageFlow.Client

   A low-level client representing Amazon WorkMail Message Flow

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

      import boto3

      client = boto3.client('workmailmessageflow')

These are the available methods:

* can_paginate

* close

* get_paginator

* get_raw_message_content

* get_waiter

* put_raw_message_content
WorkMailMessageFlow / Client / get_paginator


get_paginator
*************

WorkMailMessageFlow.Client.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:
      "botocore.paginate.Paginator"

   Returns:
      A paginator object.
WorkMailMessageFlow / Client / can_paginate


can_paginate
************

WorkMailMessageFlow.Client.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.
WorkMailMessageFlow / Client / get_waiter


get_waiter
**********

WorkMailMessageFlow.Client.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"
WorkMailMessageFlow / Client / get_raw_message_content


get_raw_message_content
***********************

WorkMailMessageFlow.Client.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"
WorkMailMessageFlow / Client / close


close
*****

WorkMailMessageFlow.Client.close()

   Closes underlying endpoint connections.
WorkMailMessageFlow / Client / put_raw_message_content


put_raw_message_content
***********************

WorkMailMessageFlow.Client.put_raw_message_content(**kwargs)

   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.

   Note:

     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.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.put_raw_message_content(
          messageId='string',
          content={
              's3Reference': {
                  'bucket': 'string',
                  'key': 'string',
                  'objectVersion': 'string'
              }
          }
      )

   Parameters:
      * **messageId** (*string*) --

        **[REQUIRED]**

        The identifier of the email message being updated.

      * **content** (*dict*) --

        **[REQUIRED]**

        Describes the raw message content of the updated email
        message.

        * **s3Reference** *(dict) --* **[REQUIRED]**

          The S3 reference of an email message.

          * **bucket** *(string) --* **[REQUIRED]**

            The S3 bucket name.

          * **key** *(string) --* **[REQUIRED]**

            The S3 key object name.

          * **objectVersion** *(string) --*

            If you enable versioning for the bucket, you can specify
            the object version.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "WorkMailMessageFlow.Client.exceptions.ResourceNotFoundException"

   * "WorkMailMessageFlow.Client.exceptions.InvalidContentLocation"

   * "WorkMailMessageFlow.Client.exceptions.MessageRejected"

   * "WorkMailMessageFlow.Client.exceptions.MessageFrozen"