FISClient#
Auto-generated documentation for FIS type annotations stubs module mypy-boto3-fis.
FISClient#
Type annotations and code completion for boto3.client("fis")
.
boto3 documentation
# FISClient usage example
from boto3.session import Session
from mypy_boto3_fis.client import FISClient
def get_fis_client() -> FISClient:
return Session().client("fis")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("fis").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("fis")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_fis.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("fis").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("fis").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_experiment_template#
Creates an experiment template.
Type annotations and code completion for boto3.client("fis").create_experiment_template
method.
boto3 documentation
# create_experiment_template method definition
def create_experiment_template(
self,
*,
clientToken: str,
description: str,
stopConditions: Sequence[CreateExperimentTemplateStopConditionInputTypeDef], # (1)
actions: Mapping[str, CreateExperimentTemplateActionInputTypeDef], # (2)
roleArn: str,
targets: Mapping[str, CreateExperimentTemplateTargetInputTypeDef] = ..., # (3)
tags: Mapping[str, str] = ...,
logConfiguration: CreateExperimentTemplateLogConfigurationInputTypeDef = ..., # (4)
experimentOptions: CreateExperimentTemplateExperimentOptionsInputTypeDef = ..., # (5)
experimentReportConfiguration: CreateExperimentTemplateReportConfigurationInputTypeDef = ..., # (6)
) -> CreateExperimentTemplateResponseTypeDef: # (7)
...
- See CreateExperimentTemplateStopConditionInputTypeDef
- See CreateExperimentTemplateActionInputTypeDef
- See CreateExperimentTemplateTargetInputTypeDef
- See CreateExperimentTemplateLogConfigurationInputTypeDef
- See CreateExperimentTemplateExperimentOptionsInputTypeDef
- See CreateExperimentTemplateReportConfigurationInputTypeDef
- See CreateExperimentTemplateResponseTypeDef
# create_experiment_template method usage example with argument unpacking
kwargs: CreateExperimentTemplateRequestRequestTypeDef = { # (1)
"clientToken": ...,
"description": ...,
"stopConditions": ...,
"actions": ...,
"roleArn": ...,
}
parent.create_experiment_template(**kwargs)
create_target_account_configuration#
Creates a target account configuration for the experiment template.
Type annotations and code completion for boto3.client("fis").create_target_account_configuration
method.
boto3 documentation
# create_target_account_configuration method definition
def create_target_account_configuration(
self,
*,
experimentTemplateId: str,
accountId: str,
roleArn: str,
clientToken: str = ...,
description: str = ...,
) -> CreateTargetAccountConfigurationResponseTypeDef: # (1)
...
# create_target_account_configuration method usage example with argument unpacking
kwargs: CreateTargetAccountConfigurationRequestRequestTypeDef = { # (1)
"experimentTemplateId": ...,
"accountId": ...,
"roleArn": ...,
}
parent.create_target_account_configuration(**kwargs)
delete_experiment_template#
Deletes the specified experiment template.
Type annotations and code completion for boto3.client("fis").delete_experiment_template
method.
boto3 documentation
# delete_experiment_template method definition
def delete_experiment_template(
self,
*,
id: str,
) -> DeleteExperimentTemplateResponseTypeDef: # (1)
...
# delete_experiment_template method usage example with argument unpacking
kwargs: DeleteExperimentTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_experiment_template(**kwargs)
delete_target_account_configuration#
Deletes the specified target account configuration of the experiment template.
Type annotations and code completion for boto3.client("fis").delete_target_account_configuration
method.
boto3 documentation
# delete_target_account_configuration method definition
def delete_target_account_configuration(
self,
*,
experimentTemplateId: str,
accountId: str,
) -> DeleteTargetAccountConfigurationResponseTypeDef: # (1)
...
# delete_target_account_configuration method usage example with argument unpacking
kwargs: DeleteTargetAccountConfigurationRequestRequestTypeDef = { # (1)
"experimentTemplateId": ...,
"accountId": ...,
}
parent.delete_target_account_configuration(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("fis").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_action#
Gets information about the specified FIS action.
Type annotations and code completion for boto3.client("fis").get_action
method.
boto3 documentation
# get_action method definition
def get_action(
self,
*,
id: str,
) -> GetActionResponseTypeDef: # (1)
...
# get_action method usage example with argument unpacking
kwargs: GetActionRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_action(**kwargs)
get_experiment#
Gets information about the specified experiment.
Type annotations and code completion for boto3.client("fis").get_experiment
method.
boto3 documentation
# get_experiment method definition
def get_experiment(
self,
*,
id: str,
) -> GetExperimentResponseTypeDef: # (1)
...
# get_experiment method usage example with argument unpacking
kwargs: GetExperimentRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_experiment(**kwargs)
get_experiment_target_account_configuration#
Gets information about the specified target account configuration of the experiment.
Type annotations and code completion for boto3.client("fis").get_experiment_target_account_configuration
method.
boto3 documentation
# get_experiment_target_account_configuration method definition
def get_experiment_target_account_configuration(
self,
*,
experimentId: str,
accountId: str,
) -> GetExperimentTargetAccountConfigurationResponseTypeDef: # (1)
...
# get_experiment_target_account_configuration method usage example with argument unpacking
kwargs: GetExperimentTargetAccountConfigurationRequestRequestTypeDef = { # (1)
"experimentId": ...,
"accountId": ...,
}
parent.get_experiment_target_account_configuration(**kwargs)
get_experiment_template#
Gets information about the specified experiment template.
Type annotations and code completion for boto3.client("fis").get_experiment_template
method.
boto3 documentation
# get_experiment_template method definition
def get_experiment_template(
self,
*,
id: str,
) -> GetExperimentTemplateResponseTypeDef: # (1)
...
# get_experiment_template method usage example with argument unpacking
kwargs: GetExperimentTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_experiment_template(**kwargs)
get_safety_lever#
Gets information about the specified safety lever.
Type annotations and code completion for boto3.client("fis").get_safety_lever
method.
boto3 documentation
# get_safety_lever method definition
def get_safety_lever(
self,
*,
id: str,
) -> GetSafetyLeverResponseTypeDef: # (1)
...
# get_safety_lever method usage example with argument unpacking
kwargs: GetSafetyLeverRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_safety_lever(**kwargs)
get_target_account_configuration#
Gets information about the specified target account configuration of the experiment template.
Type annotations and code completion for boto3.client("fis").get_target_account_configuration
method.
boto3 documentation
# get_target_account_configuration method definition
def get_target_account_configuration(
self,
*,
experimentTemplateId: str,
accountId: str,
) -> GetTargetAccountConfigurationResponseTypeDef: # (1)
...
# get_target_account_configuration method usage example with argument unpacking
kwargs: GetTargetAccountConfigurationRequestRequestTypeDef = { # (1)
"experimentTemplateId": ...,
"accountId": ...,
}
parent.get_target_account_configuration(**kwargs)
get_target_resource_type#
Gets information about the specified resource type.
Type annotations and code completion for boto3.client("fis").get_target_resource_type
method.
boto3 documentation
# get_target_resource_type method definition
def get_target_resource_type(
self,
*,
resourceType: str,
) -> GetTargetResourceTypeResponseTypeDef: # (1)
...
# get_target_resource_type method usage example with argument unpacking
kwargs: GetTargetResourceTypeRequestRequestTypeDef = { # (1)
"resourceType": ...,
}
parent.get_target_resource_type(**kwargs)
list_actions#
Lists the available FIS actions.
Type annotations and code completion for boto3.client("fis").list_actions
method.
boto3 documentation
# list_actions method definition
def list_actions(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListActionsResponseTypeDef: # (1)
...
# list_actions method usage example with argument unpacking
kwargs: ListActionsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_actions(**kwargs)
list_experiment_resolved_targets#
Lists the resolved targets information of the specified experiment.
Type annotations and code completion for boto3.client("fis").list_experiment_resolved_targets
method.
boto3 documentation
# list_experiment_resolved_targets method definition
def list_experiment_resolved_targets(
self,
*,
experimentId: str,
maxResults: int = ...,
nextToken: str = ...,
targetName: str = ...,
) -> ListExperimentResolvedTargetsResponseTypeDef: # (1)
...
# list_experiment_resolved_targets method usage example with argument unpacking
kwargs: ListExperimentResolvedTargetsRequestRequestTypeDef = { # (1)
"experimentId": ...,
}
parent.list_experiment_resolved_targets(**kwargs)
list_experiment_target_account_configurations#
Lists the target account configurations of the specified experiment.
Type annotations and code completion for boto3.client("fis").list_experiment_target_account_configurations
method.
boto3 documentation
# list_experiment_target_account_configurations method definition
def list_experiment_target_account_configurations(
self,
*,
experimentId: str,
nextToken: str = ...,
) -> ListExperimentTargetAccountConfigurationsResponseTypeDef: # (1)
...
# list_experiment_target_account_configurations method usage example with argument unpacking
kwargs: ListExperimentTargetAccountConfigurationsRequestRequestTypeDef = { # (1)
"experimentId": ...,
}
parent.list_experiment_target_account_configurations(**kwargs)
list_experiment_templates#
Lists your experiment templates.
Type annotations and code completion for boto3.client("fis").list_experiment_templates
method.
boto3 documentation
# list_experiment_templates method definition
def list_experiment_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListExperimentTemplatesResponseTypeDef: # (1)
...
# list_experiment_templates method usage example with argument unpacking
kwargs: ListExperimentTemplatesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_experiment_templates(**kwargs)
list_experiments#
Lists your experiments.
Type annotations and code completion for boto3.client("fis").list_experiments
method.
boto3 documentation
# list_experiments method definition
def list_experiments(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
experimentTemplateId: str = ...,
) -> ListExperimentsResponseTypeDef: # (1)
...
# list_experiments method usage example with argument unpacking
kwargs: ListExperimentsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_experiments(**kwargs)
list_tags_for_resource#
Lists the tags for the specified resource.
Type annotations and code completion for boto3.client("fis").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_target_account_configurations#
Lists the target account configurations of the specified experiment template.
Type annotations and code completion for boto3.client("fis").list_target_account_configurations
method.
boto3 documentation
# list_target_account_configurations method definition
def list_target_account_configurations(
self,
*,
experimentTemplateId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTargetAccountConfigurationsResponseTypeDef: # (1)
...
# list_target_account_configurations method usage example with argument unpacking
kwargs: ListTargetAccountConfigurationsRequestRequestTypeDef = { # (1)
"experimentTemplateId": ...,
}
parent.list_target_account_configurations(**kwargs)
list_target_resource_types#
Lists the target resource types.
Type annotations and code completion for boto3.client("fis").list_target_resource_types
method.
boto3 documentation
# list_target_resource_types method definition
def list_target_resource_types(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTargetResourceTypesResponseTypeDef: # (1)
...
# list_target_resource_types method usage example with argument unpacking
kwargs: ListTargetResourceTypesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_target_resource_types(**kwargs)
start_experiment#
Starts running an experiment from the specified experiment template.
Type annotations and code completion for boto3.client("fis").start_experiment
method.
boto3 documentation
# start_experiment method definition
def start_experiment(
self,
*,
clientToken: str,
experimentTemplateId: str,
experimentOptions: StartExperimentExperimentOptionsInputTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
) -> StartExperimentResponseTypeDef: # (2)
...
# start_experiment method usage example with argument unpacking
kwargs: StartExperimentRequestRequestTypeDef = { # (1)
"clientToken": ...,
"experimentTemplateId": ...,
}
parent.start_experiment(**kwargs)
stop_experiment#
Stops the specified experiment.
Type annotations and code completion for boto3.client("fis").stop_experiment
method.
boto3 documentation
# stop_experiment method definition
def stop_experiment(
self,
*,
id: str,
) -> StopExperimentResponseTypeDef: # (1)
...
# stop_experiment method usage example with argument unpacking
kwargs: StopExperimentRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.stop_experiment(**kwargs)
tag_resource#
Applies the specified tags to the specified resource.
Type annotations and code completion for boto3.client("fis").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes the specified tags from the specified resource.
Type annotations and code completion for boto3.client("fis").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str] = ...,
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.untag_resource(**kwargs)
update_experiment_template#
Updates the specified experiment template.
Type annotations and code completion for boto3.client("fis").update_experiment_template
method.
boto3 documentation
# update_experiment_template method definition
def update_experiment_template(
self,
*,
id: str,
description: str = ...,
stopConditions: Sequence[UpdateExperimentTemplateStopConditionInputTypeDef] = ..., # (1)
targets: Mapping[str, UpdateExperimentTemplateTargetInputTypeDef] = ..., # (2)
actions: Mapping[str, UpdateExperimentTemplateActionInputItemTypeDef] = ..., # (3)
roleArn: str = ...,
logConfiguration: UpdateExperimentTemplateLogConfigurationInputTypeDef = ..., # (4)
experimentOptions: UpdateExperimentTemplateExperimentOptionsInputTypeDef = ..., # (5)
experimentReportConfiguration: UpdateExperimentTemplateReportConfigurationInputTypeDef = ..., # (6)
) -> UpdateExperimentTemplateResponseTypeDef: # (7)
...
- See UpdateExperimentTemplateStopConditionInputTypeDef
- See UpdateExperimentTemplateTargetInputTypeDef
- See UpdateExperimentTemplateActionInputItemTypeDef
- See UpdateExperimentTemplateLogConfigurationInputTypeDef
- See UpdateExperimentTemplateExperimentOptionsInputTypeDef
- See UpdateExperimentTemplateReportConfigurationInputTypeDef
- See UpdateExperimentTemplateResponseTypeDef
# update_experiment_template method usage example with argument unpacking
kwargs: UpdateExperimentTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_experiment_template(**kwargs)
update_safety_lever_state#
Updates the specified safety lever state.
Type annotations and code completion for boto3.client("fis").update_safety_lever_state
method.
boto3 documentation
# update_safety_lever_state method definition
def update_safety_lever_state(
self,
*,
id: str,
state: UpdateSafetyLeverStateInputTypeDef, # (1)
) -> UpdateSafetyLeverStateResponseTypeDef: # (2)
...
# update_safety_lever_state method usage example with argument unpacking
kwargs: UpdateSafetyLeverStateRequestRequestTypeDef = { # (1)
"id": ...,
"state": ...,
}
parent.update_safety_lever_state(**kwargs)
update_target_account_configuration#
Updates the target account configuration for the specified experiment template.
Type annotations and code completion for boto3.client("fis").update_target_account_configuration
method.
boto3 documentation
# update_target_account_configuration method definition
def update_target_account_configuration(
self,
*,
experimentTemplateId: str,
accountId: str,
roleArn: str = ...,
description: str = ...,
) -> UpdateTargetAccountConfigurationResponseTypeDef: # (1)
...
# update_target_account_configuration method usage example with argument unpacking
kwargs: UpdateTargetAccountConfigurationRequestRequestTypeDef = { # (1)
"experimentTemplateId": ...,
"accountId": ...,
}
parent.update_target_account_configuration(**kwargs)