FIS

Client

class FIS.Client

A low-level client representing AWS Fault Injection Simulator (FIS)

AWS Fault Injection Simulator is a managed service that enables you to perform fault injection experiments on your AWS workloads. For more information, see the AWS Fault Injection Simulator User Guide .

client = session.create_client('fis')

These are the available methods:

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.
create_experiment_template(**kwargs)

Creates an experiment template.

To create a template, specify the following information:

  • Targets : A target can be a specific resource in your AWS 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 the AWS Fault Injection Simulator 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'
        }
    },
    actions={
        'string': {
            'actionId': 'string',
            'description': 'string',
            'parameters': {
                'string': 'string'
            },
            'targets': {
                'string': 'string'
            },
            'startAfter': [
                'string',
            ]
        }
    },
    roleArn='string',
    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.

  • description (string) --

    [REQUIRED]

    A description for the experiment template. Can contain up to 64 letters (A-Z and a-z).

  • 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.

        • resourceType (string) -- [REQUIRED]

          The AWS 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) --

            Describes a filter used for the target resource input in an experiment template.

            • 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.
  • actions (dict) --

    [REQUIRED]

    The actions for the experiment.

    • (string) --
      • (dict) --

        Specifies an action for an experiment template.

        • actionId (string) -- [REQUIRED]

          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) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.

  • tags (dict) --

    The tags to apply to the experiment template.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'experimentTemplate': {
        'id': 'string',
        'description': 'string',
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': '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'
        }
    }
}

Response Structure

  • (dict) --

    • experimentTemplate (dict) --

      Information about the experiment template.

      • id (string) --

        The ID 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.

      • 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) --

Exceptions

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',
        'description': 'string',
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': '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'
        }
    }
}

Response Structure

  • (dict) --
    • experimentTemplate (dict) --

      Information about the experiment template.

      • id (string) --

        The ID 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.

      • 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) --

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_action(**kwargs)

Gets information about the specified AWS 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',
        '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.

      • 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

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',
        'experimentTemplateId': 'string',
        'roleArn': 'string',
        'state': {
            'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
            'reason': 'string'
        },
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': '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',
                    'reason': 'string'
                }
            }
        },
        'stopConditions': [
            {
                'source': 'string',
                'value': 'string'
            },
        ],
        'creationTime': datetime(2015, 1, 1),
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • experiment (dict) --

      Information about the experiment.

      • id (string) --

        The ID 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 AWS 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.

      • 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.

      • 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.

      • 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 the experiment was created.

      • startTime (datetime) --

        The time that the experiment was started.

      • endTime (datetime) --

        The time that the experiment ended.

      • tags (dict) --

        The tags for the experiment.

        • (string) --
          • (string) --

Exceptions

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',
        'description': 'string',
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': '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'
        }
    }
}

Response Structure

  • (dict) --
    • experimentTemplate (dict) --

      Information about the experiment template.

      • id (string) --

        The ID 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.

      • 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) --

Exceptions

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
L{botocore.paginate.Paginator}
Returns
A paginator object.
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
list_actions(**kwargs)

Lists the available AWS 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',
            '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.

        • 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

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',
            '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.

        • 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

list_experiments(**kwargs)

Lists your experiments.

See also: AWS API Documentation

Request Syntax

response = client.list_experiments(
    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

{
    'experiments': [
        {
            'id': 'string',
            'experimentTemplateId': 'string',
            'state': {
                'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
                'reason': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • experiments (list) --

      The experiments.

      • (dict) --

        Provides a summary of an experiment.

        • id (string) --

          The ID 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.

        • creationTime (datetime) --

          The time that the experiment was created.

        • tags (dict) --

          The tags for the experiment.

          • (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

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) --
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',
    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.

  • tags (dict) --

    The tags to apply to the experiment.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'experiment': {
        'id': 'string',
        'experimentTemplateId': 'string',
        'roleArn': 'string',
        'state': {
            'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
            'reason': 'string'
        },
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': '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',
                    'reason': 'string'
                }
            }
        },
        'stopConditions': [
            {
                'source': 'string',
                'value': 'string'
            },
        ],
        'creationTime': datetime(2015, 1, 1),
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • experiment (dict) --

      Information about the experiment.

      • id (string) --

        The ID 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 AWS 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.

      • 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.

      • 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.

      • 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 the experiment was created.

      • startTime (datetime) --

        The time that the experiment was started.

      • endTime (datetime) --

        The time that the experiment ended.

      • tags (dict) --

        The tags for the experiment.

        • (string) --
          • (string) --

Exceptions

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',
        'experimentTemplateId': 'string',
        'roleArn': 'string',
        'state': {
            'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
            'reason': 'string'
        },
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': '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',
                    'reason': 'string'
                }
            }
        },
        'stopConditions': [
            {
                'source': 'string',
                'value': 'string'
            },
        ],
        'creationTime': datetime(2015, 1, 1),
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • experiment (dict) --

      Information about the experiment.

      • id (string) --

        The ID 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 AWS 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.

      • 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.

      • 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.

      • 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 the experiment was created.

      • startTime (datetime) --

        The time that the experiment was started.

      • endTime (datetime) --

        The time that the experiment ended.

      • tags (dict) --

        The tags for the experiment.

        • (string) --
          • (string) --

Exceptions

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) --

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) --

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'
        }
    },
    actions={
        'string': {
            'actionId': 'string',
            'description': 'string',
            'parameters': {
                'string': 'string'
            },
            'targets': {
                'string': 'string'
            },
            'startAfter': [
                'string',
            ]
        }
    },
    roleArn='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 AWS 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) --

            Describes a filter used for the target resource input in an experiment template.

            • 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.

  • 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 AWS FIS service permission to perform service actions on your behalf.
Return type

dict

Returns

Response Syntax

{
    'experimentTemplate': {
        'id': 'string',
        'description': 'string',
        'targets': {
            'string': {
                'resourceType': 'string',
                'resourceArns': [
                    'string',
                ],
                'resourceTags': {
                    'string': 'string'
                },
                'filters': [
                    {
                        'path': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'selectionMode': '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'
        }
    }
}

Response Structure

  • (dict) --

    • experimentTemplate (dict) --

      Information about the experiment template.

      • id (string) --

        The ID 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.

      • 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) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class FIS.Client.exceptions.ConflictException

The request could not be processed because of a conflict.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request could not be processed because of a conflict.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FIS.Client.exceptions.ResourceNotFoundException

The specified resource cannot be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource cannot be found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FIS.Client.exceptions.ServiceQuotaExceededException

You have exceeded your service quota.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You have exceeded your service quota.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FIS.Client.exceptions.ValidationException

The specified input is not valid, or fails to satisfy the constraints for the request.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified input is not valid, or fails to satisfy the constraints for the request.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: