Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartBlueprintRun

Starts a new run of the specified blueprint.

Request Syntax


{
   "BlueprintName": "string",
   "Parameters": "string",
   "RoleArn": "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.

BlueprintName

The name of the blueprint.

Type: String

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

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Parameters

Specifies the parameters as a BlueprintParameters object.

Type: String

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

Required: No

RoleArn

Specifies the IAM role used to create the workflow.

Type: String

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

Pattern: arn:aws[^:]*:iam::[0-9]*:role/.+

Required: Yes

Response Syntax


{
   "RunId": "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.

RunId

The run ID for this blueprint run.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Errors

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

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

IllegalBlueprintStateException

The blueprint is in an invalid state to perform a requested operation.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

ResourceNumberLimitExceededException

A resource numerical limit was exceeded.

HTTP Status Code: 400