Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

StartExecution

Triggers new execution of a specific tool.

Request Syntax


{
   "executionParameters": "string",
   "roleArn": "string",
   "storageRegion": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "targetRegions": [ "string" ],
   "toolId": "string",
   "toolVersionId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

executionParameters

Tool Execution Parameter.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32764.

Required: No

roleArn

ARN of Service Role passed which will be used to execute Diagnostic Tool

Type: String

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

Pattern: arn:aws[a-z0-9-]*:iam::\d{12}:role\/[\w\-\/.@+=,]{1,65}

Required: Yes

storageRegion

Select AWS Region where you want to store execution output from available options

Type: String

Valid Values: us-east-2 | us-west-2 | eu-west-1

Required: Yes

tags

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an execution. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

targetRegions

List of AWS Region Diagnostic Tool service allowed to query AWS Services during tool execution

Type: Array of strings

Required: Yes

toolId

Unique-id of Diagnostic Tool which you want to execute

Type: String

Length Constraints: Minimum length of 8. Maximum length of 64.

Pattern: \w+

Required: Yes

toolVersionId

Associate Version id for tool which you to execution

Type: String

Length Constraints: Minimum length of 5. Maximum length of 17.

Pattern: [0-9]{1,5}.[0-9]{1,5}.[0-9]{1,5}

Required: No

Response Syntax


{
   "execution": { 
      "creationTime": number,
      "executionId": "string",
      "parameters": "string",
      "requesterArn": "string",
      "requesterId": "string",
      "requestState": "string",
      "roleArn": "string",
      "status": "string",
      "storageRegion": "string",
      "targetRegions": [ "string" ],
      "toolId": "string",
      "toolVersionId": "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.

execution

Execution Information Metadata

Type: Execution object

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

message: Throttle error message.

HTTP Status Code: 400

InternalServerException

The request failed because of an internal error. Try your request again later

message: Error Message
retryAfterSeconds: Second after which client can retry the transaction

HTTP Status Code: 500

ResourceNotFoundException

The request failed because it references a resource that doesn't exist.

message: Reason for the resource not found.
resourceId: The unique ID of the resource referenced in the failed request.
resourceType: The resource type of the resource referenced in the failed request.

HTTP Status Code: 400

ServiceQuotaExceededException

The request failed because it would cause a service quota to be exceeded.

message: Failure message.
quotaCode: The quota code recognized by the AWS Service Quotas service.
resourceId: The unique ID of the resource referenced in the failed request.
resourceType: The resource type of the resource referenced in the failed request.
serviceCode: The code for the AWS-service; that owns the quota.

HTTP Status Code: 400

ThrottlingException

The request failed because it exceeded a throttling quota.

message: Throttle error message.
quotaCode: The quota code recognized by the AWS Service Quotas service.
retryAfterSeconds: Second after which client can retry the transaction
serviceCode: The code for the AWS-service; that owns the quota.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.
message: Description of the error.
reason: Reason the request failed validation.

HTTP Status Code: 400

Examples

This example illustrates one usage of StartExecution.

Example

Using AWS JSON protocol (default)

Sample Request



POST / HTTP/1.1
Host: ts.us-east-2.amazonaws.com
X-Amz-Target: Troubleshooting.StartExecution
Content-Type: application/x-amz-json-1.0
X-Amz-Date: <Date>
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
{
    "toolId": "EC2SystemsManager",
    "toolVersionId": "1.0.0",
    "roleArn": "<sample role>",
    "targetRegions": [
        "us-east-1"
    ],
    "storageRegion": "us-east-2",
    "parameters": {"apis":[true,true,true,false,false,false,false,false]}
}

Sample Response



HTTP/1.1 200 OK
x-amzn-RequestId: <requestId>
Content-Length: 0
Date: <Date>
Content-Type: application/x-amz-json-1.0
{
    "execution": {
        "creationTime": 1700601,
        "executionId": "e-aaaaaaaaa",
        "requestState": "SUBMITTED",
        "requesterArn": "requesterArn",
        "requesterId": "user-id",
        "roleArn": "<sample role>",
        "status": "CREATED",
        "storageRegion": "us-east-2",
        "tags": [],
        "targetRegions": [
            "us-east-1"
        ],
        "toolId": "EC2SystemsManager",
        "toolVersionId": "1.0.0"
    }
}