Describe Predefined Attribute

connect_describe_predefined_attribute

R Documentation

Describes a predefined attribute for the specified Connect Customer instance¶

Description¶

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.

Usage¶

connect_describe_predefined_attribute(InstanceId, Name)

Arguments¶

InstanceId

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

Name

[required] The name of the predefined attribute.

Value¶

A list with the following syntax:

list(
  PredefinedAttribute = list(
    Name = "string",
    Values = list(
      StringList = list(
        "string"
      )
    ),
    Purposes = list(
      "string"
    ),
    AttributeConfiguration = list(
      EnableValueValidationOnAssociation = TRUE|FALSE,
      IsReadOnly = TRUE|FALSE
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string"
  )
)

Request syntax¶

svc$describe_predefined_attribute(
  InstanceId = "string",
  Name = "string"
)