SearchPredefinedAttributesCommand

Suggest an Edit

Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, SearchPredefinedAttributesCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, SearchPredefinedAttributesCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // SearchPredefinedAttributesRequest
  InstanceId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  SearchCriteria: { // PredefinedAttributeSearchCriteria
    OrConditions: [ // PredefinedAttributeSearchConditionList
      {
        OrConditions: [
          "<PredefinedAttributeSearchCriteria>",
        ],
        AndConditions: [
          "<PredefinedAttributeSearchCriteria>",
        ],
        StringCondition: { // StringCondition
          FieldName: "STRING_VALUE",
          Value: "STRING_VALUE",
          ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
        },
      },
    ],
    AndConditions: [
      "<PredefinedAttributeSearchCriteria>",
    ],
    StringCondition: {
      FieldName: "STRING_VALUE",
      Value: "STRING_VALUE",
      ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
    },
  },
};
const command = new SearchPredefinedAttributesCommand(input);
const response = await client.send(command);
// { // SearchPredefinedAttributesResponse
//   PredefinedAttributes: [ // PredefinedAttributeSearchSummaryList
//     { // PredefinedAttribute
//       Name: "STRING_VALUE",
//       Values: { // PredefinedAttributeValues Union: only one key present
//         StringList: [ // PredefinedAttributeStringValuesList
//           "STRING_VALUE",
//         ],
//       },
//       LastModifiedTime: new Date("TIMESTAMP"),
//       LastModifiedRegion: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
//   ApproximateTotalCount: Number("long"),
// };

SearchPredefinedAttributesCommand Input

See SearchPredefinedAttributesCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

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

MaxResults
number | undefined

The maximum number of results to return per page.

NextToken
string | undefined

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.

SearchCriteria
PredefinedAttributeSearchCriteria | undefined

The search criteria to be used to return predefined attributes.

SearchPredefinedAttributesCommand Output

See SearchPredefinedAttributesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ApproximateTotalCount
number | undefined

The approximate number of predefined attributes which matched your search query.

NextToken
string | undefined

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.

PredefinedAttributes
PredefinedAttribute[] | undefined

Predefined attributes matched by the search criteria.

Throws

Name
Fault
Details
InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.