Amazon Connect Service

This API is in preview release for Amazon Connect and is subject to change.

Searches security profiles in an Amazon Connect instance, with optional filtering.

See also: AWS API Documentation

Request Syntax

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

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 SearchCriteria:

dict

param SearchCriteria:

The search criteria to be used to return security profiles.

• OrConditions (list) --

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

  • (dict) --

    The search criteria to be used to return security profiles.

• AndConditions (list) --

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

  • (dict) --

    The search criteria to be used to return security profiles.

• StringCondition (dict) --

  A leaf node condition which can be used to specify a string condition, for example, username = 'abc'.

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

type SearchFilter:

dict

param SearchFilter:

Filters to be applied to search results.

• TagFilter (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:

  • Top level list specifies conditions that need to be applied with OR operator

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

    • (list) --

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

  • AndConditions (list) --

    A list of conditions which would be applied together with an AND 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.

    • TagKey (string) --

      The tag key in the tag condition.

    • TagValue (string) --

      The tag value in the tag condition.

rtype:

dict

returns:

Response Syntax

{
    'SecurityProfiles': [
        {
            'Id': 'string',
            'OrganizationResourceId': 'string',
            'Arn': 'string',
            'SecurityProfileName': 'string',
            'Description': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

• (dict) --

  • SecurityProfiles (list) --

    Information about the security profiles.

    • (dict) --

      Information about the returned security profiles.

      • Id (string) --

        The identifier of the security profile.

      • OrganizationResourceId (string) --

        The organization resource identifier.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the security profile.

      • SecurityProfileName (string) --

        The name of the security profile.

      • Description (string) --

        The description of the security profile.

      • Tags (dict) --

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

        • (string) --

          • (string) --

  • NextToken (string) --

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

  • ApproximateTotalCount (integer) --

    The total number of security profiles which matched your search query.