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

# 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)
) -> CreateExperimentTemplateResponseTypeDef:  # (6)
    ...
  1. See CreateExperimentTemplateStopConditionInputTypeDef
  2. See CreateExperimentTemplateActionInputTypeDef
  3. See CreateExperimentTemplateTargetInputTypeDef
  4. See CreateExperimentTemplateLogConfigurationInputTypeDef
  5. See CreateExperimentTemplateExperimentOptionsInputTypeDef
  6. See CreateExperimentTemplateResponseTypeDef
# create_experiment_template method usage example with argument unpacking

kwargs: CreateExperimentTemplateRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
    "description": ...,
    "stopConditions": ...,
    "actions": ...,
    "roleArn": ...,
}

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

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)
    ...
  1. See CreateTargetAccountConfigurationResponseTypeDef
# create_target_account_configuration method usage example with argument unpacking

kwargs: CreateTargetAccountConfigurationRequestRequestTypeDef = {  # (1)
    "experimentTemplateId": ...,
    "accountId": ...,
    "roleArn": ...,
}

parent.create_target_account_configuration(**kwargs)
  1. See CreateTargetAccountConfigurationRequestRequestTypeDef

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)
    ...
  1. See DeleteExperimentTemplateResponseTypeDef
# delete_experiment_template method usage example with argument unpacking

kwargs: DeleteExperimentTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

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

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)
    ...
  1. See DeleteTargetAccountConfigurationResponseTypeDef
# delete_target_account_configuration method usage example with argument unpacking

kwargs: DeleteTargetAccountConfigurationRequestRequestTypeDef = {  # (1)
    "experimentTemplateId": ...,
    "accountId": ...,
}

parent.delete_target_account_configuration(**kwargs)
  1. See DeleteTargetAccountConfigurationRequestRequestTypeDef

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)
    ...
  1. See GetActionResponseTypeDef
# get_action method usage example with argument unpacking

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

# get_experiment method definition

def get_experiment(
    self,
    *,
    id: str,
) -> GetExperimentResponseTypeDef:  # (1)
    ...
  1. See GetExperimentResponseTypeDef
# get_experiment method usage example with argument unpacking

kwargs: GetExperimentRequestRequestTypeDef = {  # (1)
    "id": ...,
}

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

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)
    ...
  1. See GetExperimentTargetAccountConfigurationResponseTypeDef
# get_experiment_target_account_configuration method usage example with argument unpacking

kwargs: GetExperimentTargetAccountConfigurationRequestRequestTypeDef = {  # (1)
    "experimentId": ...,
    "accountId": ...,
}

parent.get_experiment_target_account_configuration(**kwargs)
  1. See GetExperimentTargetAccountConfigurationRequestRequestTypeDef

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)
    ...
  1. See GetExperimentTemplateResponseTypeDef
# get_experiment_template method usage example with argument unpacking

kwargs: GetExperimentTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

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

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.