FIS / Client / create_experiment_template

create_experiment_template#

FIS.Client.create_experiment_template(**kwargs)#

Creates an experiment template.

An experiment template includes the following components:

Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.
Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.

For more information, see experiment templates in the Fault Injection Service User Guide.

Request Syntax

response = client.create_experiment_template(
    clientToken='string',
    description='string',
    stopConditions=[
        {
            'source': 'string',
            'value': 'string'
        },
    ],
    targets={
        'string': {
            'resourceType': 'string',
            'resourceArns': [
                'string',
            ],
            'resourceTags': {
                'string': 'string'
            },
            'filters': [
                {
                    'path': 'string',
                    'values': [
                        'string',
                    ]
                },
            ],
            'selectionMode': 'string',
            'parameters': {
                'string': 'string'
            }
        }
    },
    actions={
        'string': {
            'actionId': 'string',
            'description': 'string',
            'parameters': {
                'string': 'string'
            },
            'targets': {
                'string': 'string'
            },
            'startAfter': [
                'string',
            ]
        }
    },
    roleArn='string',
    tags={
        'string': 'string'
    },
    logConfiguration={
        'cloudWatchLogsConfiguration': {
            'logGroupArn': 'string'
        },
        's3Configuration': {
            'bucketName': 'string',
            'prefix': 'string'
        },
        'logSchemaVersion': 123
    },
    experimentOptions={
        'accountTargeting': 'single-account'|'multi-account',
        'emptyTargetResolutionMode': 'fail'|'skip'
    },
    experimentReportConfiguration={
        'outputs': {
            's3Configuration': {
                'bucketName': 'string',
                'prefix': 'string'
            }
        },
        'dataSources': {
            'cloudWatchDashboards': [
                {
                    'dashboardIdentifier': 'string'
                },
            ]
        },
        'preExperimentDuration': 'string',
        'postExperimentDuration': 'string'
    }
)

Parameters:

clientToken (string) –
[REQUIRED]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.
description (string) –
[REQUIRED]

A description for the experiment template.
stopConditions (list) –
[REQUIRED]

The stop conditions.
- (dict) –
  
  Specifies a stop condition for an experiment template.
  - source (string) – [REQUIRED]
    
    The source for the stop condition. Specify aws:cloudwatch:alarm if the stop condition is defined by a CloudWatch alarm. Specify none if there is no stop condition.
  - value (string) –
    
    The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.
targets (dict) –
The targets for the experiment.
- (string) –
  - (dict) –
    
    Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags.
    
    For more information, see Targets in the Fault Injection Service User Guide.
    - resourceType (string) – [REQUIRED]
      
      The resource type. The resource type must be supported for the specified action.
    - resourceArns (list) –
      
      The Amazon Resource Names (ARNs) of the resources.
      - (string) –
    - resourceTags (dict) –
      
      The tags for the target resources.
      - (string) –
        
        (string) –
    - filters (list) –
      
      The filters to apply to identify target resources using specific attributes.
      - (dict) –
        
        Specifies a filter used for the target resource input in an experiment template.
        
        For more information, see Resource filters in the Fault Injection Service User Guide.
        
        path (string) – [REQUIRED]
        
        The attribute path for the filter.
        
        values (list) – [REQUIRED]
        
        The attribute values for the filter.
        
        (string) –
    - selectionMode (string) – [REQUIRED]
      
      Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.
      - ALL - Run the action on all identified targets. This is the default.
      - COUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random. For example, COUNT(1) selects one of the targets.
      - PERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets at random. For example, PERCENT(25) selects 25% of the targets.
    - parameters (dict) –
      
      The resource type parameters.
      - (string) –
        
        (string) –
actions (dict) –
[REQUIRED]

The actions for the experiment.
- (string) –
  - (dict) –
    
    Specifies an action for an experiment template.
    
    For more information, see Actions in the Fault Injection Service User Guide.
    - actionId (string) – [REQUIRED]
      
      The ID of the action. The format of the action ID is: aws:service-name:action-type.
    - description (string) –
      
      A description for the action.
    - parameters (dict) –
      
      The parameters for the action, if applicable.
      - (string) –
        
        (string) –
    - targets (dict) –
      
      The targets for the action.
      - (string) –
        
        (string) –
    - startAfter (list) –
      
      The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
      - (string) –
roleArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
tags (dict) –
The tags to apply to the experiment template.
- (string) –
  - (string) –
logConfiguration (dict) –
The configuration for experiment logging.
- cloudWatchLogsConfiguration (dict) –
  
  The configuration for experiment logging to Amazon CloudWatch Logs.
  - logGroupArn (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
- s3Configuration (dict) –
  
  The configuration for experiment logging to Amazon S3.
  - bucketName (string) – [REQUIRED]
    
    The name of the destination bucket.
  - prefix (string) –
    
    The bucket prefix.
- logSchemaVersion (integer) – [REQUIRED]
  
  The schema version.
experimentOptions (dict) –
The experiment options for the experiment template.
- accountTargeting (string) –
  
  Specifies the account targeting setting for experiment options.
- emptyTargetResolutionMode (string) –
  
  Specifies the empty target resolution mode for experiment options.
experimentReportConfiguration (dict) –
The experiment report configuration for the experiment template.
- outputs (dict) –
  
  The output destinations of the experiment report.
  - s3Configuration (dict) –
    
    The S3 destination for the experiment report.
    - bucketName (string) –
      
      The name of the S3 bucket where the experiment report will be stored.
    - prefix (string) –
      
      The prefix of the S3 bucket where the experiment report will be stored.
- dataSources (dict) –
  
  The data sources for the experiment report.
  - cloudWatchDashboards (list) –
    
    The CloudWatch dashboards to include as data sources in the experiment report.
    - (dict) –
      
      Specifies the CloudWatch dashboard for the experiment report.
      - dashboardIdentifier (string) –
        
        The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
- preExperimentDuration (string) –
  
  The duration before the experiment start time for the data sources to include in the report.
- postExperimentDuration (string) –
  
  The duration after the experiment end time for the data sources to include in the report.

Return type:

dict

Returns:

Response Syntax

{
    'experimentTemplate': {
        'id': 'string',
        'arn': 'string',
        'description': 'string',
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': 'string',
                'parameters': {
                    'string': 'string'
                }
            }
        },
        'actions': {
            'string': {
                'actionId': 'string',
                'description': 'string',
                'parameters': {
                    'string': 'string'
                },
                'targets': {
                    'string': 'string'
                },
                'startAfter': [
                    'string',
                ]
            }
        },
        'stopConditions': [
            {
                'source': 'string',
                'value': 'string'
            },
        ],
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1),
        'roleArn': 'string',
        'tags': {
            'string': 'string'
        },
        'logConfiguration': {
            'cloudWatchLogsConfiguration': {
                'logGroupArn': 'string'
            },
            's3Configuration': {
                'bucketName': 'string',
                'prefix': 'string'
            },
            'logSchemaVersion': 123
        },
        'experimentOptions': {
            'accountTargeting': 'single-account'|'multi-account',
            'emptyTargetResolutionMode': 'fail'|'skip'
        },
        'targetAccountConfigurationsCount': 123,
        'experimentReportConfiguration': {
            'outputs': {
                's3Configuration': {
                    'bucketName': 'string',
                    'prefix': 'string'
                }
            },
            'dataSources': {
                'cloudWatchDashboards': [
                    {
                        'dashboardIdentifier': 'string'
                    },
                ]
            },
            'preExperimentDuration': 'string',
            'postExperimentDuration': 'string'
        }
    }
}

Response Structure

(dict) –
- experimentTemplate (dict) –
  
  Information about the experiment template.
  - id (string) –
    
    The ID of the experiment template.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the experiment template.
  - description (string) –
    
    The description for the experiment template.
  - targets (dict) –
    
    The targets for the experiment.
    - (string) –
      - (dict) –
        
        Describes a target for an experiment template.
        
        resourceType (string) –
        
        The resource type.
        
        resourceArns (list) –
        
        The Amazon Resource Names (ARNs) of the targets.
        
        (string) –
        
        resourceTags (dict) –
        
        The tags for the target resources.
        
        (string) –
        
        (string) –
        
        filters (list) –
        
        The filters to apply to identify target resources using specific attributes.
        
        (dict) –
        
        Describes a filter used for the target resources in an experiment template.
        
        path (string) –
        
        The attribute path for the filter.
        
        values (list) –
        
        The attribute values for the filter.
        
        (string) –
        
        selectionMode (string) –
        
        Scopes the identified resources to a specific count or percentage.
        
        parameters (dict) –
        
        The resource type parameters.
        
        (string) –
        
        (string) –
  - actions (dict) –
    
    The actions for the experiment.
    - (string) –
      - (dict) –
        
        Describes an action for an experiment template.
        
        actionId (string) –
        
        The ID of the action.
        
        description (string) –
        
        A description for the action.
        
        parameters (dict) –
        
        The parameters for the action.
        
        (string) –
        
        (string) –
        
        targets (dict) –
        
        The targets for the action.
        
        (string) –
        
        (string) –
        
        startAfter (list) –
        
        The name of the action that must be completed before the current action starts.
        
        (string) –
  - stopConditions (list) –
    
    The stop conditions for the experiment.
    - (dict) –
      
      Describes a stop condition for an experiment template.
      - source (string) –
        
        The source for the stop condition.
      - value (string) –
        
        The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
  - creationTime (datetime) –
    
    The time the experiment template was created.
  - lastUpdateTime (datetime) –
    
    The time the experiment template was last updated.
  - roleArn (string) –
    
    The Amazon Resource Name (ARN) of an IAM role.
  - tags (dict) –
    
    The tags for the experiment template.
    - (string) –
      - (string) –
  - logConfiguration (dict) –
    
    The configuration for experiment logging.
    - cloudWatchLogsConfiguration (dict) –
      
      The configuration for experiment logging to Amazon CloudWatch Logs.
      - logGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
    - s3Configuration (dict) –
      
      The configuration for experiment logging to Amazon S3.
      - bucketName (string) –
        
        The name of the destination bucket.
      - prefix (string) –
        
        The bucket prefix.
    - logSchemaVersion (integer) –
      
      The schema version.
  - experimentOptions (dict) –
    
    The experiment options for an experiment template.
    - accountTargeting (string) –
      
      The account targeting setting for an experiment template.
    - emptyTargetResolutionMode (string) –
      
      The empty target resolution mode for an experiment template.
  - targetAccountConfigurationsCount (integer) –
    
    The count of target account configurations for the experiment template.
  - experimentReportConfiguration (dict) –
    
    Describes the report configuration for the experiment template.
    - outputs (dict) –
      
      Describes the output destinations of the experiment report.
      - s3Configuration (dict) –
        
        The S3 destination for the experiment report.
        
        bucketName (string) –
        
        The name of the S3 bucket where the experiment report will be stored.
        
        prefix (string) –
        
        The prefix of the S3 bucket where the experiment report will be stored.
    - dataSources (dict) –
      
      The data sources for the experiment report.
      - cloudWatchDashboards (list) –
        
        The CloudWatch dashboards to include as data sources in the experiment report.
        
        (dict) –
        
        The CloudWatch dashboards to include as data sources in the experiment report.
        
        dashboardIdentifier (string) –
        
        The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
    - preExperimentDuration (string) –
      
      The duration before the experiment start time for the data sources to include in the report.
    - postExperimentDuration (string) –
      
      The duration after the experiment end time for the data sources to include in the report.

create_experiment_template#

Request Syntax

Response Syntax

Response Structure

Exceptions