Request Syntax Request Parameters Response Elements Errors Examples See Also

DeleteProgressUpdateStream

Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:

The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call).
The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).
If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call.
CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted.
Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).

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. Do not store personal data in this field.

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

HomeRegionNotSetException

The home region is not set. Set the home region to continue.

HTTP Status Code: 400

InternalServerError

Exception raised when an internal, configuration, or dependency error is 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

ResourceNotFoundException

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HTTP Status Code: 400

ServiceUnavailableException

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

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

UnauthorizedOperation

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

HTTP Status Code: 400

Examples

Delete a progress update stream

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

Sample Request



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