SSM / Client / get_execution_preview

get_execution_preview

SSM.Client.get_execution_preview(**kwargs)

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

See also: AWS API Documentation

Request Syntax

response = client.get_execution_preview(
    ExecutionPreviewId='string'
)

Parameters:

ExecutionPreviewId (string) –

[REQUIRED]

The ID of the existing execution preview.

Return type:

dict

Returns:

Response Syntax

{
    'ExecutionPreviewId': 'string',
    'EndedAt': datetime(2015, 1, 1),
    'Status': 'Pending'|'InProgress'|'Success'|'Failed',
    'StatusMessage': 'string',
    'ExecutionPreview': {
        'Automation': {
            'StepPreviews': {
                'string': 123
            },
            'Regions': [
                'string',
            ],
            'TargetPreviews': [
                {
                    'Count': 123,
                    'TargetType': 'string'
                },
            ],
            'TotalAccounts': 123
        }
    }
}

Response Structure

• (dict) –

  • ExecutionPreviewId (string) –

    The generated ID for the existing execution preview.

  • EndedAt (datetime) –

    A UTC timestamp indicating when the execution preview operation ended.

  • Status (string) –

    The current status of the execution preview operation.

  • StatusMessage (string) –

    Supplemental information about the current status of the execution preview.

  • ExecutionPreview (dict) –

    Information about the changes that would be made if an execution were run.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: Automation. 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'}
    

    • Automation (dict) –

      Information about the changes that would be made if an Automation workflow were run.

      • StepPreviews (dict) –

        Information about the type of impact a runbook step would have on a resource.

        • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

        • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

        • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn’t know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

        • (string) –

          • (integer) –

      • Regions (list) –

        Information about the Amazon Web Services Regions targeted by the execution preview.

        • (string) –

      • TargetPreviews (list) –

        Information that provides a preview of what the impact of running the specified Automation runbook would be.

        • (dict) –

          Information about the resources that would be included in the actual runbook execution, if it were to be run.

          • Count (integer) –

            The number of resources of a certain type included in an execution preview.

          • TargetType (string) –

            A type of resource that was included in the execution preview.

      • TotalAccounts (integer) –

        Information about the Amazon Web Services accounts that were included in the execution preview.

Exceptions

• SSM.Client.exceptions.InternalServerError

• SSM.Client.exceptions.ResourceNotFoundException