ConnectCases / Client / list_layouts

list_layouts#

ConnectCases.Client.list_layouts(**kwargs)#

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

See also: AWS API Documentation

Request Syntax

response = client.list_layouts(
    domainId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • 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

{
    'layouts': [
        {
            'layoutArn': 'string',
            'layoutId': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • layouts (list) –

      The layouts for the domain.

      • (dict) –

        Object for the summarized details of the layout.

        • layoutArn (string) –

          The Amazon Resource Name (ARN) of the layout.

        • layoutId (string) –

          The unique identifier for of the layout.

        • name (string) –

          The name of the layout.

    • nextToken (string) –

      The token for the next set of results. This is null if there are no more results to return.

Exceptions