ConnectCases / Client / create_layout
create_layout#
- ConnectCases.Client.create_layout(**kwargs)#
Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
Fields to display to the users
Field ordering
Note
Title and Status fields cannot be part of layouts since they are not configurable.
See also: AWS API Documentation
Request Syntax
response = client.create_layout( content={ 'basic': { 'moreInfo': { 'sections': [ { 'fieldGroup': { 'fields': [ { 'id': 'string' }, ], 'name': 'string' } }, ] }, 'topPanel': { 'sections': [ { 'fieldGroup': { 'fields': [ { 'id': 'string' }, ], 'name': 'string' } }, ] } } }, domainId='string', name='string' )
- Parameters:
content (dict) –
[REQUIRED]
Information about which fields will be present in the layout, and information about the order of the fields.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
basic
.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 can be set:
fieldGroup
.fieldGroup (dict) –
Consists of a group of fields and associated properties.
fields (list) – [REQUIRED]
Represents an ordered list containing field related information.
(dict) –
Object for field related information.
id (string) – [REQUIRED]
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 can be set:
fieldGroup
.fieldGroup (dict) –
Consists of a group of fields and associated properties.
fields (list) – [REQUIRED]
Represents an ordered list containing field related information.
(dict) –
Object for field related information.
id (string) – [REQUIRED]
Unique identifier of a field.
name (string) –
Name of the field group.
domainId (string) –
[REQUIRED]
The unique identifier of the Cases domain.
name (string) –
[REQUIRED]
The name of the layout. It must be unique for the Cases domain.
- Return type:
dict
- Returns:
Response Syntax
{ 'layoutArn': 'string', 'layoutId': 'string' }
Response Structure
(dict) –
layoutArn (string) –
The Amazon Resource Name (ARN) of the newly created layout.
layoutId (string) –
The unique identifier of the layout.
Exceptions
ConnectCases.Client.exceptions.InternalServerException
ConnectCases.Client.exceptions.ResourceNotFoundException
ConnectCases.Client.exceptions.ValidationException
ConnectCases.Client.exceptions.ThrottlingException
ConnectCases.Client.exceptions.AccessDeniedException
ConnectCases.Client.exceptions.ConflictException
ConnectCases.Client.exceptions.ServiceQuotaExceededException