Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListViews

Returns views in the given instance.

Results are sorted primarily by type, and secondarily by name.

Request Syntax


GET /views/InstanceId?maxResults=MaxResults&nextToken=NextToken&type=Type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

Pattern: ^[a-zA-Z0-9\_\-:\/]+$

Required: Yes

MaxResults

The maximum number of results to return per page. The default MaxResult size is 100.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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.

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

Pattern: ^[a-zA-Z0-9=\/+_.-]+$

Type

The type of the view.

Valid Values: CUSTOMER_MANAGED | AWS_MANAGED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ViewsSummaryList": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "Status": "string",
         "Type": "string"
      }
   ]
}

Response Elements

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

The following data is returned in JSON format by the service.

NextToken

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.

Type: String

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

Pattern: ^[a-zA-Z0-9=\/+_.-]+$

ViewsSummaryList

A list of view summaries.

Type: Array of ViewSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

TooManyRequestsException

Displayed when rate-related API limits are exceeded.

HTTP Status Code: 429