Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetExecution

Exports data based on the source data update.

Request Syntax


{
   "ExecutionId": "string",
   "ExportArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ExecutionId

The ID for this specific execution.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: ^[\S\s]*$

Required: Yes

ExportArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$

Required: Yes

Response Syntax


{
   "ExecutionId": "string",
   "ExecutionStatus": { 
      "CompletedAt": "string",
      "CreatedAt": "string",
      "LastUpdatedAt": "string",
      "StatusCode": "string",
      "StatusReason": "string"
   },
   "Export": { 
      "DataQuery": { 
         "QueryStatement": "string",
         "TableConfigurations": { 
            "string" : { 
               "string" : "string" 
            }
         }
      },
      "Description": "string",
      "DestinationConfigurations": { 
         "S3Destination": { 
            "S3Bucket": "string",
            "S3OutputConfigurations": { 
               "Compression": "string",
               "Format": "string",
               "OutputType": "string",
               "Overwrite": "string"
            },
            "S3Prefix": "string",
            "S3Region": "string"
         }
      },
      "ExportArn": "string",
      "Name": "string",
      "RefreshCadence": { 
         "Frequency": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ExecutionId

The ID for this specific execution.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: ^[\S\s]*$

ExecutionStatus

The status of this specific execution.

Type: ExecutionStatus object

Export

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.

Type: Export object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An error on the server occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The specified Amazon Resource Name (ARN) in the request doesn't exist.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon service.

HTTP Status Code: 400

Examples

The following is a sample request of the GetExecution operation.

This example illustrates one usage of GetExecution.

Sample Request


{
 "ExportArn": "arn:aws:bcm-data-exports:::export:Example/837fcfce-f85b-4600-b333-b38a12c3a927",
 "ExecutionId": "8ae3fbeb-fbeb-4048-bb39-f7c6c7e80c21"
}

The following is a sample response of the GetExecution operation.

This example illustrates one usage of GetExecution.

Sample Response


{
    "ExecutionId": "f0cfeaf0-c552-47e7-82bc-0107fbfc7a8b",
    "ExecutionStatus": {
        "CreatedAt": "2023-11-14T18:14:12.813Z",
        "LastUpdatedAt": "2023-11-14T18:18:14.252556820Z",
        "StatusCode": "DELIVERY_SUCCESS"
    },
    "Export": {
        "Name": "ExampleExportName",
        "Description": "Example Description",
        "DataQuery": {
            "QueryStatement": "SELECT identity_line_item_id, identity_time_interval, line_item_product_code,line_item_unblended_cost FROM COST_AND_USAGE_REPORT",
            "TableConfigurations": {
                "COST_AND_USAGE_REPORT": {
                    "TIME_GRANULARITY": "DAILY",
                    "INCLUDE_RESOURCES": "FALSE",
                    "INCLUDE_MANUAL_DISCOUNT_COMPATIBILITY": "FALSE",
                    "INCLUDE_SPLIT_COST_ALLOCATION_DATA": "FALSE"
                }
            }
        },
        "DestinationConfigurations": {
            "S3Destination": {
                "S3Bucket": "ExampleS3Bucket",
                "S3Prefix": "ExampleS3Prefix",
                "S3Region": "us-east-1",
                "S3OutputConfigurations": {
                    "Overwrite": "OVERWRITE_REPORT",
                    "Format": "TEXT_OR_CSV",
                    "Compression": "GZIP",
                    "OutputType": "CUSTOM"
                }
            }
        },
        "RefreshCadence": {
            "Frequency": "SYNCHRONOUS"
        }
    }
}