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

SearchViews

Searches views based on name, description, or tags.

Request Syntax


POST /search-views HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "ViewSearchCriteria"
      ],
      "OrConditions": [ 
         "ViewSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      },
      "ViewStatusCondition": "string",
      "ViewTypeCondition": "string"
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Type: String

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

Pattern: ^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

MaxResults

The maximum number of results to return per page.

Type: Integer

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

Required: No

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

Required: No

SearchCriteria

The search criteria, including field names and comparison types.

Type: ViewSearchCriteria object

Required: No

SearchFilter

Filters to apply to the search, such as tag-based filters.

Type: ViewSearchFilter object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Views": [ 
      { 
         "Arn": "string",
         "Content": { 
            "Actions": [ "string" ],
            "InputSchema": "string",
            "Template": "string"
         },
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "string",
         "Version": number,
         "VersionDescription": "string",
         "ViewContentSha256": "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.

ApproximateTotalCount

The approximate total number of views that match the search criteria.

Type: Long

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

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

Views

A list of views that match the search criteria.

Type: Array of View 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

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429