ResilienceHubV2 / Client / get_test_template

get_test_template

ResilienceHubV2.Client.get_test_template(**kwargs)

Retrieves a resilience test template by ARN, including the parameters it accepts and the fault actions it runs.

See also: AWS API Documentation

Request Syntax

response = client.get_test_template(
    testTemplateArn='string'
)

Parameters:

testTemplateArn (string) –

[REQUIRED]

The ARN of the test template to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'testTemplate': {
        'testTemplateArn': 'string',
        'name': 'string',
        'description': 'string',
        'parameters': [
            {
                'name': 'string',
                'description': 'string',
                'type': 'STRING'|'STRING_LIST'|'INTEGER',
                'required': True|False,
                'defaultValue': 'string',
                'maxValues': 123
            },
        ],
        'actions': [
            {
                'actionId': 'string',
                'description': 'string',
                'resourceType': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • testTemplate (dict) –

    The requested test template.

    • testTemplateArn (string) –

      The ARN of the test template.

    • name (string) –

      The name of the test template.

    • description (string) –

      A description of the test template.

    • parameters (list) –

      The parameters the test template accepts.

      • (dict) –

        Describes a parameter accepted by a test template.

        • name (string) –

          The name of the parameter.

        • description (string) –

          A description of the parameter.

        • type (string) –

          The data type of the parameter.

        • required (boolean) –

          Indicates whether the parameter is required.

        • defaultValue (string) –

          The default value of the parameter.

        • maxValues (integer) –

          The maximum number of values the parameter accepts.

    • actions (list) –

      The fault actions the test template runs.

      • (dict) –

        Represents a fault action that a test runs, along with the resource type it targets.

        • actionId (string) –

          The identifier of the fault action.

        • description (string) –

          A description of the fault action.

        • resourceType (string) –

          The resource type that the action targets.

Exceptions

• ResilienceHubV2.Client.exceptions.InternalServerException

• ResilienceHubV2.Client.exceptions.ResourceNotFoundException

• ResilienceHubV2.Client.exceptions.ValidationException

• ResilienceHubV2.Client.exceptions.AccessDeniedException