Search Security Profiles

connect_search_security_profiles

R Documentation

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

Description¶

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

For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Usage¶

connect_search_security_profiles(InstanceId, NextToken, MaxResults,
  SearchCriteria, SearchFilter)

Arguments¶

InstanceId

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

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.

MaxResults

The maximum number of results to return per page.

SearchCriteria

The search criteria to be used to return security profiles.

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.

The currently supported value for FieldName: name

SearchFilter

Filters to be applied to search results.

Value¶

A list with the following syntax:

list(
  SecurityProfiles = list(
    list(
      Id = "string",
      OrganizationResourceId = "string",
      Arn = "string",
      SecurityProfileName = "string",
      Description = "string",
      Tags = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_security_profiles(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      FieldName = "string",
      Value = "string",
      ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    )
  ),
  SearchFilter = list(
    TagFilter = list(
      OrConditions = list(
        list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      AndConditions = list(
        list(
          TagKey = "string",
          TagValue = "string"
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    )
  )
)