FIS *** Client ====== class FIS.Client A low-level client representing AWS Fault Injection Simulator (FIS) Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Service User Guide. import boto3 client = boto3.client('fis') These are the available methods: * can_paginate * close * create_experiment_template * create_target_account_configuration * delete_experiment_template * delete_target_account_configuration * get_action * get_experiment * get_experiment_target_account_configuration * get_experiment_template * get_paginator * get_safety_lever * get_target_account_configuration * get_target_resource_type * get_waiter * list_actions * list_experiment_resolved_targets * list_experiment_target_account_configurations * list_experiment_templates * list_experiments * list_tags_for_resource * list_target_account_configurations * list_target_resource_types * start_experiment * stop_experiment * tag_resource * untag_resource * update_experiment_template * update_safety_lever_state * update_target_account_configuration Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListActions * ListExperimentResolvedTargets * ListExperimentTemplates * ListExperiments * ListTargetAccountConfigurations * ListTargetResourceTypes FIS / Paginator / ListExperimentResolvedTargets ListExperimentResolvedTargets ***************************** class FIS.Paginator.ListExperimentResolvedTargets paginator = client.get_paginator('list_experiment_resolved_targets') paginate(**kwargs) Creates an iterator that will paginate through responses from "FIS.Client.list_experiment_resolved_targets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( experimentId='string', targetName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **experimentId** (*string*) -- **[REQUIRED]** The ID of the experiment. * **targetName** (*string*) -- The name of the target. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'resolvedTargets': [ { 'resourceType': 'string', 'targetName': 'string', 'targetInformation': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **resolvedTargets** *(list) --* The resolved targets. * *(dict) --* Describes a resolved target. * **resourceType** *(string) --* The resource type of the target. * **targetName** *(string) --* The name of the target. * **targetInformation** *(dict) --* Information about the target. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. FIS / Paginator / ListTargetAccountConfigurations ListTargetAccountConfigurations ******************************* class FIS.Paginator.ListTargetAccountConfigurations paginator = client.get_paginator('list_target_account_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "FIS.Client.list_target_account_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( experimentTemplateId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **experimentTemplateId** (*string*) -- **[REQUIRED]** The ID of the experiment template. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'targetAccountConfigurations': [ { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **targetAccountConfigurations** *(list) --* The target account configurations. * *(dict) --* Provides a summary of a target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. * **NextToken** *(string) --* A token to resume pagination. FIS / Paginator / ListExperiments ListExperiments *************** class FIS.Paginator.ListExperiments paginator = client.get_paginator('list_experiments') paginate(**kwargs) Creates an iterator that will paginate through responses from "FIS.Client.list_experiments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( experimentTemplateId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **experimentTemplateId** (*string*) -- The ID of the experiment template. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'experiments': [ { 'id': 'string', 'arn': 'string', 'experimentTemplateId': 'string', 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed'|'cancelled', 'reason': 'string', 'error': { 'accountId': 'string', 'code': 'string', 'location': 'string' } }, 'creationTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'experimentOptions': { 'accountTargeting': 'single-account'|'multi-account', 'emptyTargetResolutionMode': 'fail'|'skip', 'actionsMode': 'skip-all'|'run-all' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **experiments** *(list) --* The experiments. * *(dict) --* Provides a summary of an experiment. * **id** *(string) --* The ID of the experiment. * **arn** *(string) --* The Amazon Resource Name (ARN) of the experiment. * **experimentTemplateId** *(string) --* The ID of the experiment template. * **state** *(dict) --* The state of the experiment. * **status** *(string) --* The state of the experiment. * **reason** *(string) --* The reason for the state. * **error** *(dict) --* The error information of the experiment when the action has "failed". * **accountId** *(string) --* The Amazon Web Services Account ID where the experiment failure occurred. * **code** *(string) --* The error code for the failed experiment. * **location** *(string) --* Context for the section of the experiment template that failed. * **creationTime** *(datetime) --* The time that the experiment was created. * **tags** *(dict) --* The tags for the experiment. * *(string) --* * *(string) --* * **experimentOptions** *(dict) --* The experiment options for the experiment. * **accountTargeting** *(string) --* The account targeting setting for an experiment. * **emptyTargetResolutionMode** *(string) --* The empty target resolution mode for an experiment. * **actionsMode** *(string) --* The actions mode of the experiment that is set from the StartExperiment API command. * **NextToken** *(string) --* A token to resume pagination. FIS / Paginator / ListExperimentTemplates ListExperimentTemplates *********************** class FIS.Paginator.ListExperimentTemplates paginator = client.get_paginator('list_experiment_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "FIS.Client.list_experiment_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'experimentTemplates': [ { 'id': 'string', 'arn': 'string', 'description': 'string', 'creationTime': datetime(2015, 1, 1), 'lastUpdateTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **experimentTemplates** *(list) --* The experiment templates. * *(dict) --* Provides a summary of an 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 of the experiment template. * **creationTime** *(datetime) --* The time that the experiment template was created. * **lastUpdateTime** *(datetime) --* The time that the experiment template was last updated. * **tags** *(dict) --* The tags for the experiment template. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. FIS / Paginator / ListActions ListActions *********** class FIS.Paginator.ListActions paginator = client.get_paginator('list_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "FIS.Client.list_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'actions': [ { 'id': 'string', 'arn': 'string', 'description': 'string', 'targets': { 'string': { 'resourceType': 'string' } }, 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **actions** *(list) --* The actions. * *(dict) --* Provides a summary of an action. * **id** *(string) --* The ID of the action. * **arn** *(string) --* The Amazon Resource Name (ARN) of the action. * **description** *(string) --* The description for the action. * **targets** *(dict) --* The targets for the action. * *(string) --* * *(dict) --* Describes a target for an action. * **resourceType** *(string) --* The resource type of the target. * **tags** *(dict) --* The tags for the action. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. FIS / Paginator / ListTargetResourceTypes ListTargetResourceTypes *********************** class FIS.Paginator.ListTargetResourceTypes paginator = client.get_paginator('list_target_resource_types') paginate(**kwargs) Creates an iterator that will paginate through responses from "FIS.Client.list_target_resource_types()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'targetResourceTypes': [ { 'resourceType': 'string', 'description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **targetResourceTypes** *(list) --* The target resource types. * *(dict) --* Describes a resource type. * **resourceType** *(string) --* The resource type. * **description** *(string) --* A description of the resource type. * **NextToken** *(string) --* A token to resume pagination. FIS / Client / get_paginator get_paginator ************* FIS.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. FIS / Client / delete_experiment_template delete_experiment_template ************************** FIS.Client.delete_experiment_template(**kwargs) Deletes the specified experiment template. See also: AWS API Documentation **Request Syntax** response = client.delete_experiment_template( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the experiment template. 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. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / list_experiment_templates list_experiment_templates ************************* FIS.Client.list_experiment_templates(**kwargs) Lists your experiment templates. See also: AWS API Documentation **Request Syntax** response = client.list_experiment_templates( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **nextToken** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'experimentTemplates': [ { 'id': 'string', 'arn': 'string', 'description': 'string', 'creationTime': datetime(2015, 1, 1), 'lastUpdateTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **experimentTemplates** *(list) --* The experiment templates. * *(dict) --* Provides a summary of an 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 of the experiment template. * **creationTime** *(datetime) --* The time that the experiment template was created. * **lastUpdateTime** *(datetime) --* The time that the experiment template was last updated. * **tags** *(dict) --* The tags for the experiment template. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. **Exceptions** * "FIS.Client.exceptions.ValidationException" FIS / Client / list_experiments list_experiments **************** FIS.Client.list_experiments(**kwargs) Lists your experiments. See also: AWS API Documentation **Request Syntax** response = client.list_experiments( maxResults=123, nextToken='string', experimentTemplateId='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **nextToken** (*string*) -- The token for the next page of results. * **experimentTemplateId** (*string*) -- The ID of the experiment template. Return type: dict Returns: **Response Syntax** { 'experiments': [ { 'id': 'string', 'arn': 'string', 'experimentTemplateId': 'string', 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed'|'cancelled', 'reason': 'string', 'error': { 'accountId': 'string', 'code': 'string', 'location': 'string' } }, 'creationTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'experimentOptions': { 'accountTargeting': 'single-account'|'multi-account', 'emptyTargetResolutionMode': 'fail'|'skip', 'actionsMode': 'skip-all'|'run-all' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **experiments** *(list) --* The experiments. * *(dict) --* Provides a summary of an experiment. * **id** *(string) --* The ID of the experiment. * **arn** *(string) --* The Amazon Resource Name (ARN) of the experiment. * **experimentTemplateId** *(string) --* The ID of the experiment template. * **state** *(dict) --* The state of the experiment. * **status** *(string) --* The state of the experiment. * **reason** *(string) --* The reason for the state. * **error** *(dict) --* The error information of the experiment when the action has "failed". * **accountId** *(string) --* The Amazon Web Services Account ID where the experiment failure occurred. * **code** *(string) --* The error code for the failed experiment. * **location** *(string) --* Context for the section of the experiment template that failed. * **creationTime** *(datetime) --* The time that the experiment was created. * **tags** *(dict) --* The tags for the experiment. * *(string) --* * *(string) --* * **experimentOptions** *(dict) --* The experiment options for the experiment. * **accountTargeting** *(string) --* The account targeting setting for an experiment. * **emptyTargetResolutionMode** *(string) --* The empty target resolution mode for an experiment. * **actionsMode** *(string) --* The actions mode of the experiment that is set from the StartExperiment API command. * **nextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. **Exceptions** * "FIS.Client.exceptions.ValidationException" FIS / Client / can_paginate can_paginate ************ FIS.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. FIS / Client / list_actions list_actions ************ FIS.Client.list_actions(**kwargs) Lists the available FIS actions. See also: AWS API Documentation **Request Syntax** response = client.list_actions( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **nextToken** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'actions': [ { 'id': 'string', 'arn': 'string', 'description': 'string', 'targets': { 'string': { 'resourceType': 'string' } }, 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **actions** *(list) --* The actions. * *(dict) --* Provides a summary of an action. * **id** *(string) --* The ID of the action. * **arn** *(string) --* The Amazon Resource Name (ARN) of the action. * **description** *(string) --* The description for the action. * **targets** *(dict) --* The targets for the action. * *(string) --* * *(dict) --* Describes a target for an action. * **resourceType** *(string) --* The resource type of the target. * **tags** *(dict) --* The tags for the action. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. **Exceptions** * "FIS.Client.exceptions.ValidationException" FIS / Client / list_experiment_target_account_configurations list_experiment_target_account_configurations ********************************************* FIS.Client.list_experiment_target_account_configurations(**kwargs) Lists the target account configurations of the specified experiment. See also: AWS API Documentation **Request Syntax** response = client.list_experiment_target_account_configurations( experimentId='string', nextToken='string' ) Parameters: * **experimentId** (*string*) -- **[REQUIRED]** The ID of the experiment. * **nextToken** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'targetAccountConfigurations': [ { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **targetAccountConfigurations** *(list) --* The target account configurations. * *(dict) --* Provides a summary of a target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. * **nextToken** *(string) --* The token to use to retrieve the next page of results. This value is null when there are no more results to return. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / list_experiment_resolved_targets list_experiment_resolved_targets ******************************** FIS.Client.list_experiment_resolved_targets(**kwargs) Lists the resolved targets information of the specified experiment. See also: AWS API Documentation **Request Syntax** response = client.list_experiment_resolved_targets( experimentId='string', maxResults=123, nextToken='string', targetName='string' ) Parameters: * **experimentId** (*string*) -- **[REQUIRED]** The ID of the experiment. * **maxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. * **nextToken** (*string*) -- The token for the next page of results. * **targetName** (*string*) -- The name of the target. Return type: dict Returns: **Response Syntax** { 'resolvedTargets': [ { 'resourceType': 'string', 'targetName': 'string', 'targetInformation': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **resolvedTargets** *(list) --* The resolved targets. * *(dict) --* Describes a resolved target. * **resourceType** *(string) --* The resource type of the target. * **targetName** *(string) --* The name of the target. * **targetInformation** *(dict) --* Information about the target. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token to use to retrieve the next page of results. This value is null when there are no more results to return. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / get_experiment_template get_experiment_template *********************** FIS.Client.get_experiment_template(**kwargs) Gets information about the specified experiment template. See also: AWS API Documentation **Request Syntax** response = client.get_experiment_template( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the experiment template. 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. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / get_target_account_configuration get_target_account_configuration ******************************** FIS.Client.get_target_account_configuration(**kwargs) Gets information about the specified target account configuration of the experiment template. See also: AWS API Documentation **Request Syntax** response = client.get_target_account_configuration( experimentTemplateId='string', accountId='string' ) Parameters: * **experimentTemplateId** (*string*) -- **[REQUIRED]** The ID of the experiment template. * **accountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the target account. Return type: dict Returns: **Response Syntax** { 'targetAccountConfiguration': { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' } } **Response Structure** * *(dict) --* * **targetAccountConfiguration** *(dict) --* Information about the target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. **Exceptions** * "FIS.Client.exceptions.ResourceNotFoundException" * "FIS.Client.exceptions.ValidationException" FIS / Client / list_tags_for_resource list_tags_for_resource ********************** FIS.Client.list_tags_for_resource(**kwargs) Lists the tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The tags for the resource. * *(string) --* * *(string) --* FIS / Client / create_target_account_configuration create_target_account_configuration *********************************** FIS.Client.create_target_account_configuration(**kwargs) Creates a target account configuration for the experiment template. A target account configuration is required when "accountTargeting" of "experimentOptions" is set to "multi-account". For more information, see experiment options in the *Fault Injection Service User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_target_account_configuration( clientToken='string', experimentTemplateId='string', accountId='string', roleArn='string', description='string' ) Parameters: * **clientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **experimentTemplateId** (*string*) -- **[REQUIRED]** The experiment template ID. * **accountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the target account. * **roleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of an IAM role for the target account. * **description** (*string*) -- The description of the target account. Return type: dict Returns: **Response Syntax** { 'targetAccountConfiguration': { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' } } **Response Structure** * *(dict) --* * **targetAccountConfiguration** *(dict) --* Information about the target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ConflictException" * "FIS.Client.exceptions.ResourceNotFoundException" * "FIS.Client.exceptions.ServiceQuotaExceededException" FIS / Client / untag_resource untag_resource ************** FIS.Client.untag_resource(**kwargs) Removes the specified tags from the specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tagKeys** (*list*) -- The tag keys to remove. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* FIS / Client / get_waiter get_waiter ********** FIS.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" FIS / Client / delete_target_account_configuration delete_target_account_configuration *********************************** FIS.Client.delete_target_account_configuration(**kwargs) Deletes the specified target account configuration of the experiment template. See also: AWS API Documentation **Request Syntax** response = client.delete_target_account_configuration( experimentTemplateId='string', accountId='string' ) Parameters: * **experimentTemplateId** (*string*) -- **[REQUIRED]** The ID of the experiment template. * **accountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the target account. Return type: dict Returns: **Response Syntax** { 'targetAccountConfiguration': { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' } } **Response Structure** * *(dict) --* * **targetAccountConfiguration** *(dict) --* Information about the target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / update_experiment_template update_experiment_template ************************** FIS.Client.update_experiment_template(**kwargs) Updates the specified experiment template. See also: AWS API Documentation **Request Syntax** response = client.update_experiment_template( id='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', logConfiguration={ 'cloudWatchLogsConfiguration': { 'logGroupArn': 'string' }, 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' }, 'logSchemaVersion': 123 }, experimentOptions={ 'emptyTargetResolutionMode': 'fail'|'skip' }, experimentReportConfiguration={ 'outputs': { 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' } }, 'dataSources': { 'cloudWatchDashboards': [ { 'dashboardIdentifier': 'string' }, ] }, 'preExperimentDuration': 'string', 'postExperimentDuration': 'string' } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the experiment template. * **description** (*string*) -- A description for the template. * **stopConditions** (*list*) -- The stop conditions for the experiment. * *(dict) --* Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm. * **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. * **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. * **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 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) --* 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 or percentage. * **parameters** *(dict) --* The resource type parameters. * *(string) --* * *(string) --* * **actions** (*dict*) -- The actions for the experiment. * *(string) --* * *(dict) --* Specifies 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, 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*) -- The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf. * **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) --* The schema version. * **experimentOptions** (*dict*) -- The experiment options for the experiment template. * **emptyTargetResolutionMode** *(string) --* The empty target resolution mode of the experiment template. * **experimentReportConfiguration** (*dict*) -- The experiment 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) --* 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. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" * "FIS.Client.exceptions.ServiceQuotaExceededException" FIS / Client / list_target_resource_types list_target_resource_types ************************** FIS.Client.list_target_resource_types(**kwargs) Lists the target resource types. See also: AWS API Documentation **Request Syntax** response = client.list_target_resource_types( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **nextToken** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'targetResourceTypes': [ { 'resourceType': 'string', 'description': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **targetResourceTypes** *(list) --* The target resource types. * *(dict) --* Describes a resource type. * **resourceType** *(string) --* The resource type. * **description** *(string) --* A description of the resource type. * **nextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. **Exceptions** * "FIS.Client.exceptions.ValidationException" FIS / Client / update_target_account_configuration update_target_account_configuration *********************************** FIS.Client.update_target_account_configuration(**kwargs) Updates the target account configuration for the specified experiment template. See also: AWS API Documentation **Request Syntax** response = client.update_target_account_configuration( experimentTemplateId='string', accountId='string', roleArn='string', description='string' ) Parameters: * **experimentTemplateId** (*string*) -- **[REQUIRED]** The ID of the experiment template. * **accountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the target account. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role for the target account. * **description** (*string*) -- The description of the target account. Return type: dict Returns: **Response Syntax** { 'targetAccountConfiguration': { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' } } **Response Structure** * *(dict) --* * **targetAccountConfiguration** *(dict) --* Information about the target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / get_target_resource_type get_target_resource_type ************************ FIS.Client.get_target_resource_type(**kwargs) Gets information about the specified resource type. See also: AWS API Documentation **Request Syntax** response = client.get_target_resource_type( resourceType='string' ) Parameters: **resourceType** (*string*) -- **[REQUIRED]** The resource type. Return type: dict Returns: **Response Syntax** { 'targetResourceType': { 'resourceType': 'string', 'description': 'string', 'parameters': { 'string': { 'description': 'string', 'required': True|False } } } } **Response Structure** * *(dict) --* * **targetResourceType** *(dict) --* Information about the resource type. * **resourceType** *(string) --* The resource type. * **description** *(string) --* A description of the resource type. * **parameters** *(dict) --* The parameters for the resource type. * *(string) --* * *(dict) --* Describes the parameters for a resource type. Use parameters to determine which tasks are identified during target resolution. * **description** *(string) --* A description of the parameter. * **required** *(boolean) --* Indicates whether the parameter is required. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / get_experiment get_experiment ************** FIS.Client.get_experiment(**kwargs) Gets information about the specified experiment. See also: AWS API Documentation **Request Syntax** response = client.get_experiment( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the experiment. Return type: dict Returns: **Response Syntax** { 'experiment': { 'id': 'string', 'arn': 'string', 'experimentTemplateId': 'string', 'roleArn': 'string', 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed'|'cancelled', 'reason': 'string', 'error': { 'accountId': 'string', 'code': 'string', 'location': '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', ], 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'cancelled'|'stopping'|'stopped'|'failed'|'skipped', 'reason': 'string' }, 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } }, 'stopConditions': [ { 'source': 'string', 'value': 'string' }, ], 'creationTime': datetime(2015, 1, 1), 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'logConfiguration': { 'cloudWatchLogsConfiguration': { 'logGroupArn': 'string' }, 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' }, 'logSchemaVersion': 123 }, 'experimentOptions': { 'accountTargeting': 'single-account'|'multi-account', 'emptyTargetResolutionMode': 'fail'|'skip', 'actionsMode': 'skip-all'|'run-all' }, 'targetAccountConfigurationsCount': 123, 'experimentReportConfiguration': { 'outputs': { 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' } }, 'dataSources': { 'cloudWatchDashboards': [ { 'dashboardIdentifier': 'string' }, ] }, 'preExperimentDuration': 'string', 'postExperimentDuration': 'string' }, 'experimentReport': { 'state': { 'status': 'pending'|'running'|'completed'|'cancelled'|'failed', 'reason': 'string', 'error': { 'code': 'string' } }, 's3Reports': [ { 'arn': 'string', 'reportType': 'string' }, ] } } } **Response Structure** * *(dict) --* * **experiment** *(dict) --* Information about the experiment. * **id** *(string) --* The ID of the experiment. * **arn** *(string) --* The Amazon Resource Name (ARN) of the experiment. * **experimentTemplateId** *(string) --* The ID of the experiment template. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf. * **state** *(dict) --* The state of the experiment. * **status** *(string) --* The state of the experiment. * **reason** *(string) --* The reason for the state. * **error** *(dict) --* The error information of the experiment when the action has "failed". * **accountId** *(string) --* The Amazon Web Services Account ID where the experiment failure occurred. * **code** *(string) --* The error code for the failed experiment. * **location** *(string) --* Context for the section of the experiment template that failed. * **targets** *(dict) --* The targets for the experiment. * *(string) --* * *(dict) --* Describes a target for an experiment. * **resourceType** *(string) --* The resource type. * **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) --* Describes a filter used for the target resources in an experiment. * **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 the action for an experiment. * **actionId** *(string) --* The ID of the action. * **description** *(string) --* The 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 this action starts. * *(string) --* * **state** *(dict) --* The state of the action. * **status** *(string) --* The state of the action. * **reason** *(string) --* The reason for the state. * **startTime** *(datetime) --* The time that the action started. * **endTime** *(datetime) --* The time that the action ended. * **stopConditions** *(list) --* The stop conditions for the experiment. * *(dict) --* Describes the stop condition for an experiment. * **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 that the experiment was created. * **startTime** *(datetime) --* The time that the experiment started. * **endTime** *(datetime) --* The time that the experiment ended. * **tags** *(dict) --* The tags for the experiment. * *(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 the experiment. * **accountTargeting** *(string) --* The account targeting setting for an experiment. * **emptyTargetResolutionMode** *(string) --* The empty target resolution mode for an experiment. * **actionsMode** *(string) --* The actions mode of the experiment that is set from the StartExperiment API command. * **targetAccountConfigurationsCount** *(integer) --* The count of target account configurations for the experiment. * **experimentReportConfiguration** *(dict) --* The experiment report configuration for the experiment. * **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 to include in the experiment report. The dashboard widgets will be captured as snapshot graphs within the 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. * **experimentReport** *(dict) --* The experiment report for the experiment. * **state** *(dict) --* The state of the experiment report. * **status** *(string) --* The state of the experiment report generation. * **reason** *(string) --* The reason for the state of the experiment report generation. * **error** *(dict) --* The error information of the experiment when the experiment report generation has failed. * **code** *(string) --* The error code for the failed experiment report generation. * **s3Reports** *(list) --* The S3 destination of the experiment report. * *(dict) --* Describes the S3 destination for the report. * **arn** *(string) --* The Amazon Resource Name (ARN) of the generated report. * **reportType** *(string) --* The report type for the experiment report. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / get_safety_lever get_safety_lever **************** FIS.Client.get_safety_lever(**kwargs) Gets information about the specified safety lever. See also: AWS API Documentation **Request Syntax** response = client.get_safety_lever( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the safety lever. Return type: dict Returns: **Response Syntax** { 'safetyLever': { 'id': 'string', 'arn': 'string', 'state': { 'status': 'disengaged'|'engaged'|'engaging', 'reason': 'string' } } } **Response Structure** * *(dict) --* * **safetyLever** *(dict) --* Information about the safety lever. * **id** *(string) --* The ID of the safety lever. * **arn** *(string) --* The Amazon Resource Name (ARN) of the safety lever. * **state** *(dict) --* The state of the safety lever. * **status** *(string) --* The state of the safety lever. * **reason** *(string) --* The reason for the state of the safety lever. **Exceptions** * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / close close ***** FIS.Client.close() Closes underlying endpoint connections. FIS / Client / start_experiment start_experiment **************** FIS.Client.start_experiment(**kwargs) Starts running an experiment from the specified experiment template. See also: AWS API Documentation **Request Syntax** response = client.start_experiment( clientToken='string', experimentTemplateId='string', experimentOptions={ 'actionsMode': 'skip-all'|'run-all' }, tags={ 'string': '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. * **experimentTemplateId** (*string*) -- **[REQUIRED]** The ID of the experiment template. * **experimentOptions** (*dict*) -- The experiment options for running the experiment. * **actionsMode** *(string) --* Specifies the actions mode for experiment options. * **tags** (*dict*) -- The tags to apply to the experiment. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'experiment': { 'id': 'string', 'arn': 'string', 'experimentTemplateId': 'string', 'roleArn': 'string', 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed'|'cancelled', 'reason': 'string', 'error': { 'accountId': 'string', 'code': 'string', 'location': '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', ], 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'cancelled'|'stopping'|'stopped'|'failed'|'skipped', 'reason': 'string' }, 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } }, 'stopConditions': [ { 'source': 'string', 'value': 'string' }, ], 'creationTime': datetime(2015, 1, 1), 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'logConfiguration': { 'cloudWatchLogsConfiguration': { 'logGroupArn': 'string' }, 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' }, 'logSchemaVersion': 123 }, 'experimentOptions': { 'accountTargeting': 'single-account'|'multi-account', 'emptyTargetResolutionMode': 'fail'|'skip', 'actionsMode': 'skip-all'|'run-all' }, 'targetAccountConfigurationsCount': 123, 'experimentReportConfiguration': { 'outputs': { 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' } }, 'dataSources': { 'cloudWatchDashboards': [ { 'dashboardIdentifier': 'string' }, ] }, 'preExperimentDuration': 'string', 'postExperimentDuration': 'string' }, 'experimentReport': { 'state': { 'status': 'pending'|'running'|'completed'|'cancelled'|'failed', 'reason': 'string', 'error': { 'code': 'string' } }, 's3Reports': [ { 'arn': 'string', 'reportType': 'string' }, ] } } } **Response Structure** * *(dict) --* * **experiment** *(dict) --* Information about the experiment. * **id** *(string) --* The ID of the experiment. * **arn** *(string) --* The Amazon Resource Name (ARN) of the experiment. * **experimentTemplateId** *(string) --* The ID of the experiment template. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf. * **state** *(dict) --* The state of the experiment. * **status** *(string) --* The state of the experiment. * **reason** *(string) --* The reason for the state. * **error** *(dict) --* The error information of the experiment when the action has "failed". * **accountId** *(string) --* The Amazon Web Services Account ID where the experiment failure occurred. * **code** *(string) --* The error code for the failed experiment. * **location** *(string) --* Context for the section of the experiment template that failed. * **targets** *(dict) --* The targets for the experiment. * *(string) --* * *(dict) --* Describes a target for an experiment. * **resourceType** *(string) --* The resource type. * **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) --* Describes a filter used for the target resources in an experiment. * **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 the action for an experiment. * **actionId** *(string) --* The ID of the action. * **description** *(string) --* The 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 this action starts. * *(string) --* * **state** *(dict) --* The state of the action. * **status** *(string) --* The state of the action. * **reason** *(string) --* The reason for the state. * **startTime** *(datetime) --* The time that the action started. * **endTime** *(datetime) --* The time that the action ended. * **stopConditions** *(list) --* The stop conditions for the experiment. * *(dict) --* Describes the stop condition for an experiment. * **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 that the experiment was created. * **startTime** *(datetime) --* The time that the experiment started. * **endTime** *(datetime) --* The time that the experiment ended. * **tags** *(dict) --* The tags for the experiment. * *(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 the experiment. * **accountTargeting** *(string) --* The account targeting setting for an experiment. * **emptyTargetResolutionMode** *(string) --* The empty target resolution mode for an experiment. * **actionsMode** *(string) --* The actions mode of the experiment that is set from the StartExperiment API command. * **targetAccountConfigurationsCount** *(integer) --* The count of target account configurations for the experiment. * **experimentReportConfiguration** *(dict) --* The experiment report configuration for the experiment. * **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 to include in the experiment report. The dashboard widgets will be captured as snapshot graphs within the 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. * **experimentReport** *(dict) --* The experiment report for the experiment. * **state** *(dict) --* The state of the experiment report. * **status** *(string) --* The state of the experiment report generation. * **reason** *(string) --* The reason for the state of the experiment report generation. * **error** *(dict) --* The error information of the experiment when the experiment report generation has failed. * **code** *(string) --* The error code for the failed experiment report generation. * **s3Reports** *(list) --* The S3 destination of the experiment report. * *(dict) --* Describes the S3 destination for the report. * **arn** *(string) --* The Amazon Resource Name (ARN) of the generated report. * **reportType** *(string) --* The report type for the experiment report. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ConflictException" * "FIS.Client.exceptions.ResourceNotFoundException" * "FIS.Client.exceptions.ServiceQuotaExceededException" FIS / Client / list_target_account_configurations list_target_account_configurations ********************************** FIS.Client.list_target_account_configurations(**kwargs) Lists the target account configurations of the specified experiment template. See also: AWS API Documentation **Request Syntax** response = client.list_target_account_configurations( experimentTemplateId='string', maxResults=123, nextToken='string' ) Parameters: * **experimentTemplateId** (*string*) -- **[REQUIRED]** The ID of the experiment template. * **maxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. * **nextToken** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'targetAccountConfigurations': [ { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **targetAccountConfigurations** *(list) --* The target account configurations. * *(dict) --* Provides a summary of a target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. * **nextToken** *(string) --* The token to use to retrieve the next page of results. This value is null when there are no more results to return. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / get_action get_action ********** FIS.Client.get_action(**kwargs) Gets information about the specified FIS action. See also: AWS API Documentation **Request Syntax** response = client.get_action( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the action. Return type: dict Returns: **Response Syntax** { 'action': { 'id': 'string', 'arn': 'string', 'description': 'string', 'parameters': { 'string': { 'description': 'string', 'required': True|False } }, 'targets': { 'string': { 'resourceType': 'string' } }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **action** *(dict) --* Information about the action. * **id** *(string) --* The ID of the action. * **arn** *(string) --* The Amazon Resource Name (ARN) of the action. * **description** *(string) --* The description for the action. * **parameters** *(dict) --* The action parameters, if applicable. * *(string) --* * *(dict) --* Describes a parameter for an action. * **description** *(string) --* The parameter description. * **required** *(boolean) --* Indicates whether the parameter is required. * **targets** *(dict) --* The supported targets for the action. * *(string) --* * *(dict) --* Describes a target for an action. * **resourceType** *(string) --* The resource type of the target. * **tags** *(dict) --* The tags for the action. * *(string) --* * *(string) --* **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / update_safety_lever_state update_safety_lever_state ************************* FIS.Client.update_safety_lever_state(**kwargs) Updates the specified safety lever state. See also: AWS API Documentation **Request Syntax** response = client.update_safety_lever_state( id='string', state={ 'status': 'disengaged'|'engaged', 'reason': 'string' } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the safety lever. * **state** (*dict*) -- **[REQUIRED]** The state of the safety lever. * **status** *(string) --* **[REQUIRED]** The updated state of the safety lever. * **reason** *(string) --* **[REQUIRED]** The reason for updating the state of the safety lever. Return type: dict Returns: **Response Syntax** { 'safetyLever': { 'id': 'string', 'arn': 'string', 'state': { 'status': 'disengaged'|'engaged'|'engaging', 'reason': 'string' } } } **Response Structure** * *(dict) --* * **safetyLever** *(dict) --* Information about the safety lever. * **id** *(string) --* The ID of the safety lever. * **arn** *(string) --* The Amazon Resource Name (ARN) of the safety lever. * **state** *(dict) --* The state of the safety lever. * **status** *(string) --* The state of the safety lever. * **reason** *(string) --* The reason for the state of the safety lever. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ConflictException" * "FIS.Client.exceptions.ResourceNotFoundException" FIS / Client / tag_resource tag_resource ************ FIS.Client.tag_resource(**kwargs) Applies the specified tags to the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tags** (*dict*) -- **[REQUIRED]** The tags for the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* FIS / Client / get_experiment_target_account_configuration get_experiment_target_account_configuration ******************************************* FIS.Client.get_experiment_target_account_configuration(**kwargs) Gets information about the specified target account configuration of the experiment. See also: AWS API Documentation **Request Syntax** response = client.get_experiment_target_account_configuration( experimentId='string', accountId='string' ) Parameters: * **experimentId** (*string*) -- **[REQUIRED]** The ID of the experiment. * **accountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the target account. Return type: dict Returns: **Response Syntax** { 'targetAccountConfiguration': { 'roleArn': 'string', 'accountId': 'string', 'description': 'string' } } **Response Structure** * *(dict) --* * **targetAccountConfiguration** *(dict) --* Information about the target account configuration. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role for the target account. * **accountId** *(string) --* The Amazon Web Services account ID of the target account. * **description** *(string) --* The description of the target account. **Exceptions** * "FIS.Client.exceptions.ResourceNotFoundException" * "FIS.Client.exceptions.ValidationException" FIS / Client / stop_experiment stop_experiment *************** FIS.Client.stop_experiment(**kwargs) Stops the specified experiment. See also: AWS API Documentation **Request Syntax** response = client.stop_experiment( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the experiment. Return type: dict Returns: **Response Syntax** { 'experiment': { 'id': 'string', 'arn': 'string', 'experimentTemplateId': 'string', 'roleArn': 'string', 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed'|'cancelled', 'reason': 'string', 'error': { 'accountId': 'string', 'code': 'string', 'location': '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', ], 'state': { 'status': 'pending'|'initiating'|'running'|'completed'|'cancelled'|'stopping'|'stopped'|'failed'|'skipped', 'reason': 'string' }, 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } }, 'stopConditions': [ { 'source': 'string', 'value': 'string' }, ], 'creationTime': datetime(2015, 1, 1), 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'logConfiguration': { 'cloudWatchLogsConfiguration': { 'logGroupArn': 'string' }, 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' }, 'logSchemaVersion': 123 }, 'experimentOptions': { 'accountTargeting': 'single-account'|'multi-account', 'emptyTargetResolutionMode': 'fail'|'skip', 'actionsMode': 'skip-all'|'run-all' }, 'targetAccountConfigurationsCount': 123, 'experimentReportConfiguration': { 'outputs': { 's3Configuration': { 'bucketName': 'string', 'prefix': 'string' } }, 'dataSources': { 'cloudWatchDashboards': [ { 'dashboardIdentifier': 'string' }, ] }, 'preExperimentDuration': 'string', 'postExperimentDuration': 'string' }, 'experimentReport': { 'state': { 'status': 'pending'|'running'|'completed'|'cancelled'|'failed', 'reason': 'string', 'error': { 'code': 'string' } }, 's3Reports': [ { 'arn': 'string', 'reportType': 'string' }, ] } } } **Response Structure** * *(dict) --* * **experiment** *(dict) --* Information about the experiment. * **id** *(string) --* The ID of the experiment. * **arn** *(string) --* The Amazon Resource Name (ARN) of the experiment. * **experimentTemplateId** *(string) --* The ID of the experiment template. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf. * **state** *(dict) --* The state of the experiment. * **status** *(string) --* The state of the experiment. * **reason** *(string) --* The reason for the state. * **error** *(dict) --* The error information of the experiment when the action has "failed". * **accountId** *(string) --* The Amazon Web Services Account ID where the experiment failure occurred. * **code** *(string) --* The error code for the failed experiment. * **location** *(string) --* Context for the section of the experiment template that failed. * **targets** *(dict) --* The targets for the experiment. * *(string) --* * *(dict) --* Describes a target for an experiment. * **resourceType** *(string) --* The resource type. * **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) --* Describes a filter used for the target resources in an experiment. * **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 the action for an experiment. * **actionId** *(string) --* The ID of the action. * **description** *(string) --* The 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 this action starts. * *(string) --* * **state** *(dict) --* The state of the action. * **status** *(string) --* The state of the action. * **reason** *(string) --* The reason for the state. * **startTime** *(datetime) --* The time that the action started. * **endTime** *(datetime) --* The time that the action ended. * **stopConditions** *(list) --* The stop conditions for the experiment. * *(dict) --* Describes the stop condition for an experiment. * **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 that the experiment was created. * **startTime** *(datetime) --* The time that the experiment started. * **endTime** *(datetime) --* The time that the experiment ended. * **tags** *(dict) --* The tags for the experiment. * *(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 the experiment. * **accountTargeting** *(string) --* The account targeting setting for an experiment. * **emptyTargetResolutionMode** *(string) --* The empty target resolution mode for an experiment. * **actionsMode** *(string) --* The actions mode of the experiment that is set from the StartExperiment API command. * **targetAccountConfigurationsCount** *(integer) --* The count of target account configurations for the experiment. * **experimentReportConfiguration** *(dict) --* The experiment report configuration for the experiment. * **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 to include in the experiment report. The dashboard widgets will be captured as snapshot graphs within the 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. * **experimentReport** *(dict) --* The experiment report for the experiment. * **state** *(dict) --* The state of the experiment report. * **status** *(string) --* The state of the experiment report generation. * **reason** *(string) --* The reason for the state of the experiment report generation. * **error** *(dict) --* The error information of the experiment when the experiment report generation has failed. * **code** *(string) --* The error code for the failed experiment report generation. * **s3Reports** *(list) --* The S3 destination of the experiment report. * *(dict) --* Describes the S3 destination for the report. * **arn** *(string) --* The Amazon Resource Name (ARN) of the generated report. * **reportType** *(string) --* The report type for the experiment report. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ResourceNotFoundException" 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*. See also: AWS API Documentation **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. **Exceptions** * "FIS.Client.exceptions.ValidationException" * "FIS.Client.exceptions.ConflictException" * "FIS.Client.exceptions.ResourceNotFoundException" * "FIS.Client.exceptions.ServiceQuotaExceededException"