Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

SearchSecurityProfiles

class Connect.Paginator.SearchSecurityProfiles
paginator = client.get_paginator('search_security_profiles')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.search_security_profiles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    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'
            }
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • SearchCriteria (dict) --

    The search criteria to be used to return security profiles.

    Note

    The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

    Note

    The currently supported value for FieldName : name

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

        Note

        The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

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

        Note

        The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

    • StringCondition (dict) --

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

      Note

      The currently supported value for FieldName : name

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

  • SearchFilter (dict) --

    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.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'SecurityProfiles': [
        {
            'Id': 'string',
            'OrganizationResourceId': 'string',
            'Arn': 'string',
            'SecurityProfileName': 'string',
            'Description': 'string',
            'Tags': {
                'string': '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) --
    • ApproximateTotalCount (integer) --

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