Connect / Client / search_agent_statuses

search_agent_statuses#

Connect.Client.search_agent_statuses(**kwargs)#

Searches AgentStatuses in an Amazon Connect instance, with optional filtering.

See also: AWS API Documentation

Request Syntax

response = client.search_agent_statuses(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    SearchFilter={
        'AttributeFilter': {
            'OrConditions': [
                {
                    'TagConditions': [
                        {
                            'TagKey': 'string',
                            'TagValue': 'string'
                        },
                    ]
                },
            ],
            'AndCondition': {
                'TagConditions': [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ]
            },
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        }
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

type SearchFilter:

dict

param SearchFilter:

Filters to be applied to search results.

  • AttributeFilter (dict) –

    An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

    • The top level list specifies conditions that need to be applied with OR operator.

    • The inner list specifies conditions that need to be applied with AND operator.

    • OrConditions (list) –

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

      • (dict) –

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

        • TagConditions (list) –

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

          • (dict) –

            A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

            • TagKey (string) –

              The tag key in the tag condition.

            • TagValue (string) –

              The tag value in the tag condition.

    • AndCondition (dict) –

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

      • TagConditions (list) –

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

        • (dict) –

          A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

          • TagKey (string) –

            The tag key in the tag condition.

          • TagValue (string) –

            The tag value in the tag condition.

    • TagCondition (dict) –

      A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

      • TagKey (string) –

        The tag key in the tag condition.

      • TagValue (string) –

        The tag value in the tag condition.

type SearchCriteria:

dict

param SearchCriteria:

The search criteria to be used to return agent statuses.

  • OrConditions (list) –

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

    • (dict) –

      The search criteria to be used to return agent statuses.

  • AndConditions (list) –

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

    Note

    The currently supported values for FieldName are name,

description, state, type, displayOrder, and resourceID.

  • (dict) –

    The search criteria to be used to return agent statuses.

  • StringCondition (dict) –

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

    Note

    The currently supported values for FieldName are name,

description, state, type, displayOrder, and resourceID.

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

rtype:

dict

returns:

Response Syntax

{
    'AgentStatuses': [
        {
            'AgentStatusARN': 'string',
            'AgentStatusId': 'string',
            'Name': 'string',
            'Description': 'string',
            'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE',
            'DisplayOrder': 123,
            'State': 'ENABLED'|'DISABLED',
            'Tags': {
                'string': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

  • (dict) –

    • AgentStatuses (list) –

      The search criteria to be used to return agent statuses.

      • (dict) –

        Contains information about an agent status.

        • AgentStatusARN (string) –

          The Amazon Resource Name (ARN) of the agent status.

        • AgentStatusId (string) –

          The identifier of the agent status.

        • Name (string) –

          The name of the agent status.

        • Description (string) –

          The description of the agent status.

        • Type (string) –

          The type of agent status.

        • DisplayOrder (integer) –

          The display order of the agent status.

        • State (string) –

          The state of the agent status.

        • Tags (dict) –

          The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

          • (string) –

            • (string) –

        • LastModifiedTime (datetime) –

          The timestamp when this resource was last modified.

        • LastModifiedRegion (string) –

          The Amazon Web Services Region where this resource was last modified.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

    • ApproximateTotalCount (integer) –

      The total number of agent statuses which matched your search query.

Exceptions