Menu
AWS Migration Hub
User Guide

CreateProgressUpdateStream

Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

Request Syntax

{ "DryRun": boolean, "ProgressUpdateStreamName": "string" }

Request Parameters

The request accepts the following data in JSON format.

DryRun

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Type: Boolean

Required: No

ProgressUpdateStreamName

The name of the ProgressUpdateStream.

Type: String

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

Pattern: [^/:|\000-\037]+

Required: Yes

Response Elements

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

Errors

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

DryRunOperation

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

HTTP Status Code: 400

InternalServerError

Exception raised when there is an internal, configuration, or dependency error encountered.

HTTP Status Code: 500

InvalidInputException

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HTTP Status Code: 400

ServiceUnavailableException

Exception raised when there is an internal, configuration, or dependency error encountered.

HTTP Status Code: 500

UnauthorizedOperation

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

HTTP Status Code: 400

Example

Create a progress update stream

The following example creates a progress update stream identified by the values passed to the required parameter ProgressUpdateStreamName in the request.

Sample Request

{ "ProgressUpdateStreamName": "SMS", "DryRun": false }

See Also

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