FIS / Client / create_target_account_configuration

create_target_account_configuration#

FIS.Client.create_target_account_configuration(**kwargs)#

Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Simulator User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_target_account_configuration(
    clientToken='string',
    experimentTemplateId='string',
    accountId='string',
    roleArn='string',
    description='string'
)
Parameters:

  • clientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • experimentTemplateId (string) –

    [REQUIRED]

    The experiment template ID.

  • accountId (string) –

    [REQUIRED]

    The AWS account ID of the target account.

  • roleArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of an IAM role for the target account.

  • description (string) – The description of the target account.

Return type:

dict

Returns:

Response Syntax

{
    'targetAccountConfiguration': {
        'roleArn': 'string',
        'accountId': 'string',
        'description': 'string'
    }
}

Response Structure

  • (dict) –

    • targetAccountConfiguration (dict) –

      Information about the target account configuration.

      • roleArn (string) –

        The Amazon Resource Name (ARN) of an IAM role for the target account.

      • accountId (string) –

        The AWS account ID of the target account.

      • description (string) –

        The description of the target account.

Exceptions

  • FIS.Client.exceptions.ValidationException

  • FIS.Client.exceptions.ConflictException

  • FIS.Client.exceptions.ResourceNotFoundException

  • FIS.Client.exceptions.ServiceQuotaExceededException