ConnectCases / Client / get_layout

get_layout#

ConnectCases.Client.get_layout(**kwargs)#

Returns the details for the requested layout.

See also: AWS API Documentation

Request Syntax

response = client.get_layout(
    domainId='string',
    layoutId='string'
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • layoutId (string) –

    [REQUIRED]

    The unique identifier of the layout.

Return type:

dict

Returns:

Response Syntax

{
    'content': {
        'basic': {
            'moreInfo': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            },
            'topPanel': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            }
        }
    },
    'createdTime': datetime(2015, 1, 1),
    'deleted': True|False,
    'lastModifiedTime': datetime(2015, 1, 1),
    'layoutArn': 'string',
    'layoutId': 'string',
    'name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • content (dict) –

      Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: basic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • basic (dict) –

        Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

        • moreInfo (dict) –

          This represents sections in a tab of the page layout.

          • sections (list) –

            Ordered list containing different kinds of sections that can be added.

            • (dict) –

              This represents a sections within a panel or tab of the page layout.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: fieldGroup. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • fieldGroup (dict) –

                Consists of a group of fields and associated properties.

                • fields (list) –

                  Represents an ordered list containing field related information.

                  • (dict) –

                    Object for field related information.

                    • id (string) –

                      Unique identifier of a field.

                • name (string) –

                  Name of the field group.

        • topPanel (dict) –

          This represents sections in a panel of the page layout.

          • sections (list) –

            Ordered list containing different kinds of sections that can be added.

            • (dict) –

              This represents a sections within a panel or tab of the page layout.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: fieldGroup. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • fieldGroup (dict) –

                Consists of a group of fields and associated properties.

                • fields (list) –

                  Represents an ordered list containing field related information.

                  • (dict) –

                    Object for field related information.

                    • id (string) –

                      Unique identifier of a field.

                • name (string) –

                  Name of the field group.

    • createdTime (datetime) –

      Timestamp at which the resource was created.

    • deleted (boolean) –

      Denotes whether or not the resource has been deleted.

    • lastModifiedTime (datetime) –

      Timestamp at which the resource was created or last modified.

    • layoutArn (string) –

      The Amazon Resource Name (ARN) of the newly created layout.

    • layoutId (string) –

      The unique identifier of the layout.

    • name (string) –

      The name of the layout. It must be unique.

    • tags (dict) –

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) –

        • (string) –

Exceptions