CreateWorkflowStepGroup - Migration Hub Orchestrator

CreateWorkflowStepGroup

Create a step group in a migration workflow.

Request Syntax

POST /workflowstepgroups HTTP/1.1 Content-type: application/json { "description": "string", "name": "string", "next": [ "string" ], "previous": [ "string" ], "workflowId": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

The description of the step group.

Type: String

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

Pattern: [-a-zA-Z0-9_.+, ]*

Required: No

name

The name of the step group.

Type: String

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

Pattern: [-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*

Required: Yes

next

The next step group.

Type: Array of strings

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

Required: No

previous

The previous step group.

Type: Array of strings

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

Required: No

workflowId

The ID of the migration workflow that will contain the step group.

Type: String

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

Pattern: [a-zA-Z0-9-]+

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "creationTime": number, "description": "string", "id": "string", "name": "string", "next": [ "string" ], "previous": [ "string" ], "tools": [ { "name": "string", "url": "string" } ], "workflowId": "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.

creationTime

The time at which the step group is created.

Type: Timestamp

description

The description of the step group.

Type: String

id

The ID of the step group.

Type: String

name

The name of the step group.

Type: String

next

The next step group.

Type: Array of strings

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

previous

The previous step group.

Type: Array of strings

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

tools

List of AWS services utilized in a migration workflow.

Type: Array of Tool objects

workflowId

The ID of the migration workflow that contains the step group.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: