Skip to content

FISClient

Index > FIS > 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

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.

Usage example
client = boto3.client("fis")

try:
    do_something(client)
except (
    client.ClientError,
    client.ConflictException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ValidationException,
) as e:
    print(e)
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

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

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

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)
) -> CreateExperimentTemplateResponseTypeDef:  # (5)
    ...
  1. See CreateExperimentTemplateStopConditionInputTypeDef
  2. See CreateExperimentTemplateActionInputTypeDef
  3. See CreateExperimentTemplateTargetInputTypeDef
  4. See CreateExperimentTemplateLogConfigurationInputTypeDef
  5. See CreateExperimentTemplateResponseTypeDef
Usage example with kwargs
kwargs: CreateExperimentTemplateRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
    "description": ...,
    "stopConditions": ...,
    "actions": ...,
    "roleArn": ...,
}

parent.create_experiment_template(**kwargs)
  1. See CreateExperimentTemplateRequestRequestTypeDef

delete_experiment_template

Deletes the specified experiment template.

Type annotations and code completion for boto3.client("fis").delete_experiment_template method. boto3 documentation

Method definition
def delete_experiment_template(
    self,
    *,
    id: str,
) -> DeleteExperimentTemplateResponseTypeDef:  # (1)
    ...
  1. See DeleteExperimentTemplateResponseTypeDef
Usage example with kwargs
kwargs: DeleteExperimentTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_experiment_template(**kwargs)
  1. See DeleteExperimentTemplateRequestRequestTypeDef

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

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

Method definition
def get_action(
    self,
    *,
    id: str,
) -> GetActionResponseTypeDef:  # (1)
    ...
  1. See GetActionResponseTypeDef
Usage example with kwargs
kwargs: GetActionRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_action(**kwargs)
  1. See GetActionRequestRequestTypeDef

get_experiment

Gets information about the specified experiment.

Type annotations and code completion for boto3.client("fis").get_experiment method. boto3 documentation

Method definition
def get_experiment(
    self,
    *,
    id: str,
) -> GetExperimentResponseTypeDef:  # (1)
    ...
  1. See GetExperimentResponseTypeDef
Usage example with kwargs
kwargs: GetExperimentRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_experiment(**kwargs)
  1. See GetExperimentRequestRequestTypeDef

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

Method definition
def get_experiment_template(
    self,
    *,
    id: str,
) -> GetExperimentTemplateResponseTypeDef:  # (1)
    ...
  1. See GetExperimentTemplateResponseTypeDef
Usage example with kwargs
kwargs: GetExperimentTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_experiment_template(**kwargs)
  1. See GetExperimentTemplateRequestRequestTypeDef

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

Method definition
def get_target_resource_type(
    self,
    *,
    resourceType: str,
) -> GetTargetResourceTypeResponseTypeDef:  # (1)
    ...
  1. See GetTargetResourceTypeResponseTypeDef
Usage example with kwargs
kwargs: GetTargetResourceTypeRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
}

parent.get_target_resource_type(**kwargs)
  1. See GetTargetResourceTypeRequestRequestTypeDef

list_actions

Lists the available FIS actions.

Type annotations and code completion for boto3.client("fis").list_actions method. boto3 documentation

Method definition
def list_actions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListActionsResponseTypeDef:  # (1)
    ...
  1. See ListActionsResponseTypeDef
Usage example with kwargs
kwargs: ListActionsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_actions(**kwargs)
  1. See ListActionsRequestRequestTypeDef

list_experiment_templates

Lists your experiment templates.

Type annotations and code completion for boto3.client("fis").list_experiment_templates method. boto3 documentation

Method definition
def list_experiment_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListExperimentTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListExperimentTemplatesResponseTypeDef
Usage example with kwargs
kwargs: ListExperimentTemplatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_experiment_templates(**kwargs)
  1. See ListExperimentTemplatesRequestRequestTypeDef

list_experiments

Lists your experiments.

Type annotations and code completion for boto3.client("fis").list_experiments method. boto3 documentation

Method definition
def list_experiments(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListExperimentsResponseTypeDef:  # (1)
    ...
  1. See ListExperimentsResponseTypeDef
Usage example with kwargs
kwargs: ListExperimentsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_experiments(**kwargs)
  1. See ListExperimentsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition
def list_target_resource_types(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTargetResourceTypesResponseTypeDef:  # (1)
    ...
  1. See ListTargetResourceTypesResponseTypeDef
Usage example with kwargs
kwargs: ListTargetResourceTypesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_target_resource_types(**kwargs)
  1. See ListTargetResourceTypesRequestRequestTypeDef

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

Method definition
def start_experiment(
    self,
    *,
    clientToken: str,
    experimentTemplateId: str,
    tags: Mapping[str, str] = ...,
) -> StartExperimentResponseTypeDef:  # (1)
    ...
  1. See StartExperimentResponseTypeDef
Usage example with kwargs
kwargs: StartExperimentRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
    "experimentTemplateId": ...,
}

parent.start_experiment(**kwargs)
  1. See StartExperimentRequestRequestTypeDef

stop_experiment

Stops the specified experiment.

Type annotations and code completion for boto3.client("fis").stop_experiment method. boto3 documentation

Method definition
def stop_experiment(
    self,
    *,
    id: str,
) -> StopExperimentResponseTypeDef:  # (1)
    ...
  1. See StopExperimentResponseTypeDef
Usage example with kwargs
kwargs: StopExperimentRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.stop_experiment(**kwargs)
  1. See StopExperimentRequestRequestTypeDef

tag_resource

Applies the specified tags to the specified resource.

Type annotations and code completion for boto3.client("fis").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the specified resource.

Type annotations and code completion for boto3.client("fis").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_experiment_template

Updates the specified experiment template.

Type annotations and code completion for boto3.client("fis").update_experiment_template method. boto3 documentation

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)
) -> UpdateExperimentTemplateResponseTypeDef:  # (5)
    ...
  1. See UpdateExperimentTemplateStopConditionInputTypeDef
  2. See UpdateExperimentTemplateTargetInputTypeDef
  3. See UpdateExperimentTemplateActionInputItemTypeDef
  4. See UpdateExperimentTemplateLogConfigurationInputTypeDef
  5. See UpdateExperimentTemplateResponseTypeDef
Usage example with kwargs
kwargs: UpdateExperimentTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_experiment_template(**kwargs)
  1. See UpdateExperimentTemplateRequestRequestTypeDef