BillingandCostManagementDataExports / Client / get_execution

get_execution#

BillingandCostManagementDataExports.Client.get_execution(**kwargs)#

Exports data based on the source data update.

See also: AWS API Documentation

Request Syntax

response = client.get_execution(
    ExecutionId='string',
    ExportArn='string'
)
Parameters:

  • ExecutionId (string) –

    [REQUIRED]

    The ID for this specific execution.

  • ExportArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Export object that generated this specific execution.

Return type:

dict

Returns:

Response Syntax

{
    'ExecutionId': 'string',
    'ExecutionStatus': {
        'CompletedAt': datetime(2015, 1, 1),
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'StatusCode': 'INITIATION_IN_PROCESS'|'QUERY_QUEUED'|'QUERY_IN_PROCESS'|'QUERY_FAILURE'|'DELIVERY_IN_PROCESS'|'DELIVERY_SUCCESS'|'DELIVERY_FAILURE',
        'StatusReason': 'INSUFFICIENT_PERMISSION'|'BILL_OWNER_CHANGED'|'INTERNAL_FAILURE'
    },
    'Export': {
        'DataQuery': {
            'QueryStatement': 'string',
            'TableConfigurations': {
                'string': {
                    'string': 'string'
                }
            }
        },
        'Description': 'string',
        'DestinationConfigurations': {
            'S3Destination': {
                'S3Bucket': 'string',
                'S3OutputConfigurations': {
                    'Compression': 'GZIP'|'PARQUET',
                    'Format': 'TEXT_OR_CSV'|'PARQUET',
                    'OutputType': 'CUSTOM',
                    'Overwrite': 'CREATE_NEW_REPORT'|'OVERWRITE_REPORT'
                },
                'S3Prefix': 'string',
                'S3Region': 'string'
            }
        },
        'ExportArn': 'string',
        'Name': 'string',
        'RefreshCadence': {
            'Frequency': 'SYNCHRONOUS'
        }
    }
}

Response Structure

  • (dict) –

    • ExecutionId (string) –

      The ID for this specific execution.

    • ExecutionStatus (dict) –

      The status of this specific execution.

      • CompletedAt (datetime) –

        The time when the execution was completed.

      • CreatedAt (datetime) –

        The time when the execution was created.

      • LastUpdatedAt (datetime) –

        The time when the execution was last updated.

      • StatusCode (string) –

        The code for the status of the execution.

      • StatusReason (string) –

        The reason for the failed status.

    • Export (dict) –

      The export data for this specific execution. This export data is a snapshot from when the execution was generated. The data could be different from the current export data if the export was updated since the execution was generated.

      • DataQuery (dict) –

        The data query for this specific data export.

        • QueryStatement (string) –

          The query statement.

        • TableConfigurations (dict) –

          The table configuration.

          • (string) –

            • (dict) –

              • (string) –

                • (string) –

      • Description (string) –

        The description for this specific data export.

      • DestinationConfigurations (dict) –

        The destination configuration for this specific data export.

        • S3Destination (dict) –

          An object that describes the destination of the data exports file.

          • S3Bucket (string) –

            The name of the Amazon S3 bucket used as the destination of a data export file.

          • S3OutputConfigurations (dict) –

            The output configuration for the data export.

            • Compression (string) –

              The compression type for the data export.

            • Format (string) –

              The file format for the data export.

            • OutputType (string) –

              The output type for the data export.

            • Overwrite (string) –

              The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.

          • S3Prefix (string) –

            The S3 path prefix you want prepended to the name of your data export.

          • S3Region (string) –

            The S3 bucket Region.

      • ExportArn (string) –

        The Amazon Resource Name (ARN) for this export.

      • Name (string) –

        The name of this specific data export.

      • RefreshCadence (dict) –

        The cadence for Amazon Web Services to update the export in your S3 bucket.

        • Frequency (string) –

          The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.

Exceptions