AWSConnectSearchUsersRequest

Objective-C

@interface AWSConnectSearchUsersRequest

Swift

class AWSConnectSearchUsersRequest

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

    InstanceID is a required field. The “Required: No” below is incorrect.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable instanceId;

    Swift

    var instanceId: String? { get set }

  • The maximum number of results to return per page.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxResults;

    Swift

    var maxResults: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable nextToken;

    Swift

    var nextToken: String? { get set }

  • The search criteria to be used to return users.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectUserSearchCriteria *_Nullable searchCriteria;

    Swift

    var searchCriteria: AWSConnectUserSearchCriteria? { get set }

  • Filters to be applied to search results.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectUserSearchFilter *_Nullable searchFilter;

    Swift

    var searchFilter: AWSConnectUserSearchFilter? { get set }