ConnectCases / Client / list_domains
list_domains#
- ConnectCases.Client.list_domains(**kwargs)#
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
See also: AWS API Documentation
Request Syntax
response = client.list_domains( maxResults=123, nextToken='string' )
- Parameters:
maxResults (integer) – The maximum number of results to return per page.
nextToken (string) – 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'domains': [ { 'domainArn': 'string', 'domainId': 'string', 'name': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
domains (list) –
The Cases domain.
(dict) –
Object for the summarized details of the domain.
domainArn (string) –
The Amazon Resource Name (ARN) of the domain.
domainId (string) –
The unique identifier of the domain.
name (string) –
The name of the domain.
nextToken (string) –
The token for the next set of results. This is null if there are no more results to return.
Exceptions
ConnectCases.Client.exceptions.InternalServerException
ConnectCases.Client.exceptions.ValidationException
ConnectCases.Client.exceptions.ThrottlingException
ConnectCases.Client.exceptions.AccessDeniedException