listWorkspacePages method

Future<ListWorkspacePagesResponse> listWorkspacePages({ required String instanceId, required String workspaceId, int? maxResults, String? nextToken, })

Lists the page configurations in a workspace, including the views assigned to each page.

May throw AccessDeniedException. May throw InternalServiceException. May throw InvalidParameterException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

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

Parameter workspaceId : The identifier of the workspace.

Parameter maxResults : The maximum number of results to return per page.

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

Implementation

Future<ListWorkspacePagesResponse> listWorkspacePages({
  required String instanceId,
  required String workspaceId,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/workspaces/${Uri.encodeComponent(instanceId)}/${Uri.encodeComponent(workspaceId)}/pages',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListWorkspacePagesResponse.fromJson(response);
}