Connect / Client / describe_predefined_attribute
describe_predefined_attribute#
- Connect.Client.describe_predefined_attribute(**kwargs)#
Describes a predefined attribute for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.describe_predefined_attribute( InstanceId='string', Name='string' )
- Parameters:
InstanceId (string) –
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Name (string) –
[REQUIRED]
The name of the predefined attribute.
- Return type:
dict
- Returns:
Response Syntax
{ 'PredefinedAttribute': { 'Name': 'string', 'Values': { 'StringList': [ 'string', ] }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } }
Response Structure
(dict) –
PredefinedAttribute (dict) –
Information about the predefined attribute.
Name (string) –
The name of the predefined attribute.
Values (dict) –
The values of the predefined attribute.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
StringList
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
StringList (list) –
Predefined attribute values of type string list.
(string) –
LastModifiedTime (datetime) –
Last modified time.
LastModifiedRegion (string) –
Last modified region.
Exceptions
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException