- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListViewVersionsCommand
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, ListViewVersionsCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListViewVersionsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListViewVersionsRequest
InstanceId: "STRING_VALUE", // required
ViewId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListViewVersionsCommand(input);
const response = await client.send(command);
// { // ListViewVersionsResponse
// ViewVersionSummaryList: [ // ViewVersionSummaryList
// { // ViewVersionSummary
// Id: "STRING_VALUE",
// Arn: "STRING_VALUE",
// Description: "STRING_VALUE",
// Name: "STRING_VALUE",
// Type: "CUSTOMER_MANAGED" || "AWS_MANAGED",
// Version: Number("int"),
// VersionDescription: "STRING_VALUE",
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListViewVersionsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. |
ViewIdRequired | string | undefined | The identifier of the view. Both |
MaxResults | number | undefined | The maximum number of results to return per page. The default MaxResult size is 100. |
NextToken | string | undefined | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
ListViewVersionsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
NextToken | string | undefined | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
ViewVersionSummaryList | ViewVersionSummary[] | undefined | A list of view version summaries. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | client | One or more of the specified parameters are not valid. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| TooManyRequestsException | client | Displayed when rate-related API limits are exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |