CREATEPREDEFINEDATTRIBUTE()`¶

About CreatePredefinedAttribute¶

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.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/CNTINSTANCEID` `/AWS1/CNTINSTANCEID`¶

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

`iv_name` `TYPE /AWS1/CNTPREDEFINEDATTRNAME` `/AWS1/CNTPREDEFINEDATTRNAME`¶

The name of the predefined attribute.

Optional arguments:¶

`io_values` `TYPE REF TO /AWS1/CL_CNTPREDEFINEDATTRVALS` `/AWS1/CL_CNTPREDEFINEDATTRVALS`¶

The values of the predefined attribute.

`it_purposes` `TYPE /AWS1/CL_CNTPREDEFINEDATTRPU00=>TT_PREDEFINEDATTRPURPOSENAME00` `TT_PREDEFINEDATTRPURPOSENAME00`¶

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

`io_attributeconfiguration` `TYPE REF TO /AWS1/CL_CNTINPPREDEFINEDATT00` `/AWS1/CL_CNTINPPREDEFINEDATT00`¶

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.

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->/aws1/if_cnt~createpredefinedattribute(
  io_attributeconfiguration = new /aws1/cl_cntinppredefinedatt00( ABAP_TRUE )
  io_values = new /aws1/cl_cntpredefinedattrvals(
    it_stringlist = VALUE /aws1/cl_cntpredefinedattrst00=>tt_predefinedattrstrvalueslist(
      ( new /aws1/cl_cntpredefinedattrst00( |string| ) )
    )
  )
  it_purposes = VALUE /aws1/cl_cntpredefinedattrpu00=>tt_predefinedattrpurposename00(
    ( new /aws1/cl_cntpredefinedattrpu00( |string| ) )
  )
  iv_instanceid = |string|
  iv_name = |string|
).

/AWS1/IF_CNT=>CREATEPREDEFINEDATTRIBUTE()¶