progress_update_streams

Creates, updates, deletes, gets or lists a progress_update_streams resource.

Overview

Name	progress_update_streams
Type	Resource
Id	aws.mgh.progress_update_streams

Fields

The following fields are returned by SELECT queries:

list_progress_update_streams

Name	Datatype	Description
progress_update_stream_name	string	The name of the ProgressUpdateStream. Do not store personal data in this field. (pattern: <code>[^/:|\000-\037]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_progress_update_streams	select	region		Lists progress update streams associated with the user account making this call.
create_progress_update_stream	insert	region, ProgressUpdateStreamName		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.
delete_progress_update_stream	delete	region		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).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_progress_update_streams

Lists progress update streams associated with the user account making this call.

SELECT
progress_update_stream_name
FROM aws.mgh.progress_update_streams
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_progress_update_stream

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.

INSERT INTO aws.mgh.progress_update_streams (
ProgressUpdateStreamName,
DryRun,
region
)
SELECT 
'{{ ProgressUpdateStreamName }}' /* required */,
{{ DryRun }},
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: progress_update_streams
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the progress_update_streams resource.
  - name: ProgressUpdateStreamName
    value: "{{ ProgressUpdateStreamName }}"
    description: |
      The name of the ProgressUpdateStream. Do not store personal data in this field.
  - name: DryRun
    value: {{ DryRun }}
    description: |
      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

DELETE examples

delete_progress_update_stream

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).

DELETE FROM aws.mgh.progress_update_streams
WHERE region = '{{ region }}' --required
;