Connect / Client / describe_predefined_attribute

describe_predefined_attribute

Connect.Client.describe_predefined_attribute(**kwargs)

Describes a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

• Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.

• Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.

For the predefined attributes per instance quota, see Connect Customer quotas.

Endpoints: See Connect Customer endpoints and quotas.

See also: AWS API Documentation

Request Syntax

response = client.describe_predefined_attribute(
    InstanceId='string',
    Name='string'
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Connect Customer 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',
            ]
        },
        'Purposes': [
            'string',
        ],
        'AttributeConfiguration': {
            'EnableValueValidationOnAssociation': True|False,
            'IsReadOnly': True|False
        },
        '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 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'}
      

      • StringList (list) –

        Predefined attribute values of type string list.

        • (string) –

    • Purposes (list) –

      Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.

      • (string) –

    • AttributeConfiguration (dict) –

      Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website.

      • EnableValueValidationOnAssociation (boolean) –

        When this parameter is set to true, Connect Customer enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for teh predefined attribute key.

      • IsReadOnly (boolean) –

        A boolean flag used to indicate whether a predefined attribute should be displayed in the Connect Customer admin website.

    • 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