predefined_attributes

Creates, updates, deletes, gets or lists a predefined_attributes resource.

Overview

Name	predefined_attributes
Type	Resource
Id	aws.connect.predefined_attributes

Fields

The following fields are returned by SELECT queries:

describe_predefined_attribute

Name	Datatype	Description
attribute_configuration	object	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.
last_modified_region	string	Last modified region. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	Last modified time.
name	string	The name of the predefined attribute.
purposes	array	Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.
values	object	Information about values of a predefined attribute.

list_predefined_attributes

Name	Datatype	Description
last_modified_region	string	Last modified region. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	Last modified time.
name	string	The name of the predefined attribute.

search_predefined_attributes

Name	Datatype	Description
attribute_configuration	object	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.
last_modified_region	string	Last modified region. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	Last modified time.
name	string	The name of the predefined attribute.
purposes	array	Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.
values	object	Information about values of a predefined attribute.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_predefined_attribute	select	instance_id, name, region		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.
list_predefined_attributes	select	instance_id, region	nextToken, maxResults	Lists predefined attributes 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.
search_predefined_attributes	select	region		Searches predefined attributes that meet certain criteria. 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.
create_predefined_attribute	insert	instance_id, region		Creates a new predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer 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 Connect Customer endpoints and quotas.
update_predefined_attribute	update	instance_id, name, region		Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas. Use cases Following are common uses cases for this API: Update 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. Update 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 Connect Customer endpoints and quotas.
delete_predefined_attribute	delete	instance_id, name, region		Deletes a predefined attribute from the specified Connect Customer instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
name	string	The name of the predefined attribute.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

describe_predefined_attribute

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.

SELECT
attribute_configuration,
last_modified_region,
last_modified_time,
name,
purposes,
values
FROM aws.connect.predefined_attributes
WHERE instance_id = '{{ instance_id }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_predefined_attributes

Lists predefined attributes 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.

SELECT
last_modified_region,
last_modified_time,
name
FROM aws.connect.predefined_attributes
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_predefined_attributes

Searches predefined attributes that meet certain criteria. 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.

SELECT
attribute_configuration,
last_modified_region,
last_modified_time,
name,
purposes,
values
FROM aws.connect.predefined_attributes
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_predefined_attribute

Creates a new predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer 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 Connect Customer endpoints and quotas.

INSERT INTO aws.connect.predefined_attributes (
Name,
Values,
Purposes,
AttributeConfiguration,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Values }}',
'{{ Purposes }}',
'{{ AttributeConfiguration }}',
'{{ instance_id }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: predefined_attributes
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the predefined_attributes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the predefined_attributes resource.
  - name: Name
    value: "{{ Name }}"
  - name: Values
    description: |
      Information about values of a predefined attribute.
    value:
      StringList:
        - "{{ StringList }}"
  - name: Purposes
    value:
      - "{{ Purposes }}"
  - name: AttributeConfiguration
    description: |
      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.
    value:
      EnableValueValidationOnAssociation: {{ EnableValueValidationOnAssociation }}

UPDATE examples

update_predefined_attribute

Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas. Use cases Following are common uses cases for this API: Update 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. Update 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 Connect Customer endpoints and quotas.

UPDATE aws.connect.predefined_attributes
SET 
Values = '{{ Values }}',
Purposes = '{{ Purposes }}',
AttributeConfiguration = '{{ AttributeConfiguration }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_predefined_attribute

Deletes a predefined attribute from the specified Connect Customer instance.

DELETE FROM aws.connect.predefined_attributes
WHERE instance_id = '{{ instance_id }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required
;