Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateTargetAccountConfiguration

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 AWS Fault Injection Service User Guide.

Request Syntax


POST /experimentTemplates/id/targetAccountConfigurations/accountId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "roleArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId

The AWS account ID of the target account.

Length Constraints: Minimum length of 12. Maximum length of 48.

Pattern: [\S]+

Required: Yes

id

The experiment template ID.

Length Constraints: Maximum length of 64.

Pattern: [\S]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\S]+

Required: No

description

The description of the target account.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [\s\S]*

Required: No

roleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: [\S]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

targetAccountConfiguration

Information about the target account configuration.

Type: TargetAccountConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request could not be processed because of a conflict.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded your service quota.

HTTP Status Code: 402

ValidationException

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

HTTP Status Code: 400