Connect / Client / create_predefined_attribute

create_predefined_attribute¶

Connect.Client.create_predefined_attribute(**kwargs)¶

Creates a new predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value.

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

Use cases

Following are common uses cases for this API:

Create an attribute 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.
Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.

Endpoints: See Amazon Connect endpoints and quotas.

Request Syntax

response = client.create_predefined_attribute(
    InstanceId='string',
    Name='string',
    Values={
        'StringList': [
            'string',
        ]
    },
    Purposes=[
        'string',
    ],
    AttributeConfiguration={
        'EnableValueValidationOnAssociation': True|False
    }
)

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.
Values (dict) –
The values of the predefined attribute.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: StringList.
- 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 Amazon Connect 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 Amazon Connect admin website.
- EnableValueValidationOnAssociation (boolean) –
  
  When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for the predefined attribute key.

Returns:

None

Exceptions

Connect.Client.exceptions.DuplicateResourceException
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.LimitExceededException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException