MailManager / Client / get_archive_export

get_archive_export#

MailManager.Client.get_archive_export(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_archive_export(
    ExportId='string'
)
Parameters:

ExportId (string) –

[REQUIRED]

The identifier of the export job to get details for.

Return type:

dict

Returns:

Response Syntax

{
    'ArchiveId': 'string',
    'ExportDestinationConfiguration': {
        'S3': {
            'S3Location': 'string'
        }
    },
    'Filters': {
        'Include': [
            {
                'BooleanExpression': {
                    'Evaluate': {
                        'Attribute': 'HAS_ATTACHMENTS'
                    },
                    'Operator': 'IS_TRUE'|'IS_FALSE'
                },
                'StringExpression': {
                    'Evaluate': {
                        'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM'
                    },
                    'Operator': 'CONTAINS',
                    'Values': [
                        'string',
                    ]
                }
            },
        ],
        'Unless': [
            {
                'BooleanExpression': {
                    'Evaluate': {
                        'Attribute': 'HAS_ATTACHMENTS'
                    },
                    'Operator': 'IS_TRUE'|'IS_FALSE'
                },
                'StringExpression': {
                    'Evaluate': {
                        'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM'
                    },
                    'Operator': 'CONTAINS',
                    'Values': [
                        'string',
                    ]
                }
            },
        ]
    },
    'FromTimestamp': datetime(2015, 1, 1),
    'MaxResults': 123,
    'Status': {
        'CompletionTimestamp': datetime(2015, 1, 1),
        'ErrorMessage': 'string',
        'State': 'QUEUED'|'PREPROCESSING'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED',
        'SubmissionTimestamp': datetime(2015, 1, 1)
    },
    'ToTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    The response containing details of the specified archive export job.

    • ArchiveId (string) –

      The identifier of the archive the email export was performed from.

    • ExportDestinationConfiguration (dict) –

      Where the exported emails are being delivered.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: S3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • S3 (dict) –

        Configuration for delivering to an Amazon S3 bucket.

        • S3Location (string) –

          The S3 location to deliver the exported email data.

    • Filters (dict) –

      The criteria used to filter emails included in the export.

      • Include (list) –

        The filter conditions for emails to include.

        • (dict) –

          A filter condition used to include or exclude emails when exporting from or searching an archive.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: BooleanExpression, StringExpression. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • BooleanExpression (dict) –

            A boolean expression to evaluate against email attributes.

            • Evaluate (dict) –

              The email attribute value to evaluate.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: Attribute. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • Attribute (string) –

                The name of the email attribute to evaluate.

            • Operator (string) –

              The boolean operator to use for evaluation.

          • StringExpression (dict) –

            A string expression to evaluate against email attributes.

            • Evaluate (dict) –

              The attribute of the email to evaluate.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: Attribute. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • Attribute (string) –

                The name of the email attribute to evaluate.

            • Operator (string) –

              The operator to use when evaluating the string values.

            • Values (list) –

              The list of string values to evaluate the email attribute against.

              • (string) –

      • Unless (list) –

        The filter conditions for emails to exclude.

        • (dict) –

          A filter condition used to include or exclude emails when exporting from or searching an archive.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: BooleanExpression, StringExpression. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • BooleanExpression (dict) –

            A boolean expression to evaluate against email attributes.

            • Evaluate (dict) –

              The email attribute value to evaluate.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: Attribute. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • Attribute (string) –

                The name of the email attribute to evaluate.

            • Operator (string) –

              The boolean operator to use for evaluation.

          • StringExpression (dict) –

            A string expression to evaluate against email attributes.

            • Evaluate (dict) –

              The attribute of the email to evaluate.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: Attribute. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • Attribute (string) –

                The name of the email attribute to evaluate.

            • Operator (string) –

              The operator to use when evaluating the string values.

            • Values (list) –

              The list of string values to evaluate the email attribute against.

              • (string) –

    • FromTimestamp (datetime) –

      The start of the timestamp range the exported emails cover.

    • MaxResults (integer) –

      The maximum number of email items included in the export.

    • Status (dict) –

      The current status of the export job.

      • CompletionTimestamp (datetime) –

        The timestamp of when the export job completed (if finished).

      • ErrorMessage (string) –

        An error message if the export job failed.

      • State (string) –

        The current state of the export job.

      • SubmissionTimestamp (datetime) –

        The timestamp of when the export job was submitted.

    • ToTimestamp (datetime) –

      The end of the date range the exported emails cover.

Exceptions