ListProgressUpdateStreamsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MigrationHubClient, ListProgressUpdateStreamsCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import
// const { MigrationHubClient, ListProgressUpdateStreamsCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import
const client = new MigrationHubClient(config);
const input = { // ListProgressUpdateStreamsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListProgressUpdateStreamsCommand(input);
const response = await client.send(command);
// { // ListProgressUpdateStreamsResult
//   ProgressUpdateStreamSummaryList: [ // ProgressUpdateStreamSummaryList
//     { // ProgressUpdateStreamSummary
//       ProgressUpdateStreamName: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListProgressUpdateStreamsCommand Input

See ListProgressUpdateStreamsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

Filter to limit the maximum number of results to list per page.

NextToken
string | undefined

If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

ListProgressUpdateStreamsCommand Output

See ListProgressUpdateStreamsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

ProgressUpdateStreamSummaryList
ProgressUpdateStreamSummary[] | undefined

List of progress update streams up to the max number of results passed in the input.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

HomeRegionNotSetException
client

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

InternalServerError
server

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

InvalidInputException
client

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

ServiceUnavailableException
server

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

ThrottlingException
client

The request was denied due to request throttling.

MigrationHubServiceException
Base exception class for all service exceptions from MigrationHub service.