Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

Searches room profiles and lists the ones that meet a set of filter criteria.

This operation returns paginated results.

Synopsis

# Creating a Request

Creates a value of SearchProfiles with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spFilters - The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
• spSortCriteria - The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
• spNextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .
• spMaxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

See: searchProfiles smart constructor.

Instances

# Request Lenses

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

# Destructuring the Response

Arguments

 :: Int sprsResponseStatus -> SearchProfilesResponse

Creates a value of SearchProfilesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sprsProfiles - The profiles that meet the specified set of filter criteria, in sort order.
• sprsNextToken - The token returned to indicate that there is more data available.
• sprsTotalCount - The total number of room profiles returned.
• sprsResponseStatus - -- | The response status code.

See: searchProfilesResponse smart constructor.

Instances