GetLayout
Returns the details for the requested layout.
Request Syntax
POST /domains/domainId/layouts/layoutId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"content": { ... },
"createdTime": "string",
"deleted": boolean,
"lastModifiedTime": "string",
"layoutArn": "string",
"layoutId": "string",
"name": "string",
"tags": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- content
-
Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
Type: LayoutContent object
Note: This object is a Union. Only one member of this object can be specified or returned.
- createdTime
-
Timestamp at which the resource was created.
Type: Timestamp
- deleted
-
Denotes whether or not the resource has been deleted.
Type: Boolean
- lastModifiedTime
-
Timestamp at which the resource was created or last modified.
Type: Timestamp
- layoutArn
-
The Amazon Resource Name (ARN) of the newly created layout.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
- layoutId
-
The unique identifier of the layout.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
- name
-
The name of the layout. It must be unique.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^.*[\S]$ -
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.
Type: String to string map
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
We couldn't process your request because of an issue with the server. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The rate has been exceeded for this API. Please try again after a few minutes.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. Check the syntax and try again.
HTTP Status Code: 400
Examples
Request and Response example
Following is an example of a content attribute.
{ }
{
"name": "My layout",
"content": {
"basic": {
"topPanel": {
"sections": [
{
"fieldGroup": {
"fields": [
{
"editable": false,
"fieldId": "[field_id_1]"
},
{
"editable": false,
"fieldId": "[field_id_2]"
}
]
}
}
]
},
"moreInfo": {
"sections": [
{
"fieldGroup": {
"name": "Address",
"fields": [
{
"editable": false,
"fieldId": "[field_id_3]"
},
{
"editable": false,
"fieldId": "[field_id_4]"
}
]
}
}
]
}
}
},
"layoutArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/layout/[layout_id]",
"layoutId": "[layout_id]",
"tags": {}
} See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
