Connect / Client / search_predefined_attributes

search_predefined_attributes#

Connect.Client.search_predefined_attributes(**kwargs)#

Predefined attributes that meet certain criteria.

See also: AWS API Documentation

Request Syntax

response = client.search_predefined_attributes(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        }
    }
)
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.

  • 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.

  • MaxResults (integer) – The maximum number of results to return per page.

  • SearchCriteria (dict) –

    The search criteria to be used to return predefined attributes.

    • OrConditions (list) –

      A list of conditions which would be applied together with an OR condition.

      • (dict) –

        The search criteria to be used to return predefined attributes.

    • AndConditions (list) –

      A list of conditions which would be applied together with an AND condition.

      • (dict) –

        The search criteria to be used to return predefined attributes.

    • StringCondition (dict) –

      A leaf node condition which can be used to specify a string condition.

      Note

      The currently supported values for FieldName are name and description.

      • FieldName (string) –

        The name of the field in the string condition.

      • Value (string) –

        The value of the string.

      • ComparisonType (string) –

        The type of comparison to be made when evaluating the string condition.

Return type:

dict

Returns:

Response Syntax

{
    'PredefinedAttributes': [
        {
            'Name': 'string',
            'Values': {
                'StringList': [
                    'string',
                ]
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

  • (dict) –

    • PredefinedAttributes (list) –

      Predefined attributes matched by the search criteria.

      • (dict) –

        Information about a predefined attribute.

        • Name (string) –

          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 will be set: StringList. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • StringList (list) –

            Predefined attribute values of type string list.

            • (string) –

        • LastModifiedTime (datetime) –

          Last modified time.

        • LastModifiedRegion (string) –

          Last modified region.

    • 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.

    • ApproximateTotalCount (integer) –

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

Exceptions