Search Email Addresses

connect_search_email_addresses

R Documentation

Searches email address in an instance, with optional filtering¶

Description¶

Searches email address in an instance, with optional filtering.

Usage¶

connect_search_email_addresses(InstanceId, MaxResults, NextToken,
  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.

MaxResults

The maximum number of results to return per page.

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.

SearchCriteria

The search criteria to be used to return email addresses.

Filters to be applied to search results.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  EmailAddresses = list(
    list(
      EmailAddressId = "string",
      EmailAddressArn = "string",
      EmailAddress = "string",
      Description = "string",
      DisplayName = "string"
    )
  ),
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_email_addresses(
  InstanceId = "string",
  MaxResults = 123,
  NextToken = "string",
  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"
      )
    )
  )
)