| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.APIGateway.GetBasePathMappings
Description
Represents a collection of BasePathMapping resources.
This operation returns paginated results.
Synopsis
- data GetBasePathMappings = GetBasePathMappings' {}
- newGetBasePathMappings :: Text -> GetBasePathMappings
- getBasePathMappings_limit :: Lens' GetBasePathMappings (Maybe Int)
- getBasePathMappings_position :: Lens' GetBasePathMappings (Maybe Text)
- getBasePathMappings_domainName :: Lens' GetBasePathMappings Text
- data GetBasePathMappingsResponse = GetBasePathMappingsResponse' {
- items :: Maybe [BasePathMapping]
- position :: Maybe Text
- httpStatus :: Int
- newGetBasePathMappingsResponse :: Int -> GetBasePathMappingsResponse
- getBasePathMappingsResponse_items :: Lens' GetBasePathMappingsResponse (Maybe [BasePathMapping])
- getBasePathMappingsResponse_position :: Lens' GetBasePathMappingsResponse (Maybe Text)
- getBasePathMappingsResponse_httpStatus :: Lens' GetBasePathMappingsResponse Int
Creating a Request
data GetBasePathMappings Source #
A request to get information about a collection of BasePathMapping resources.
See: newGetBasePathMappings smart constructor.
Constructors
| GetBasePathMappings' | |
Instances
newGetBasePathMappings Source #
Arguments
| :: Text | |
| -> GetBasePathMappings |
Create a value of GetBasePathMappings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limit:GetBasePathMappings', getBasePathMappings_limit - The maximum number of returned results per page. The default value is 25
and the maximum value is 500.
$sel:position:GetBasePathMappings', getBasePathMappings_position - The current pagination position in the paged result set.
$sel:domainName:GetBasePathMappings', getBasePathMappings_domainName - [Required] The domain name of a BasePathMapping resource.
Request Lenses
getBasePathMappings_limit :: Lens' GetBasePathMappings (Maybe Int) Source #
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
getBasePathMappings_position :: Lens' GetBasePathMappings (Maybe Text) Source #
The current pagination position in the paged result set.
getBasePathMappings_domainName :: Lens' GetBasePathMappings Text Source #
- Required
- The domain name of a BasePathMapping resource.
Destructuring the Response
data GetBasePathMappingsResponse Source #
Represents a collection of BasePathMapping resources.
See: newGetBasePathMappingsResponse smart constructor.
Constructors
| GetBasePathMappingsResponse' | |
Fields
| |
Instances
newGetBasePathMappingsResponse Source #
Create a value of GetBasePathMappingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:GetBasePathMappingsResponse', getBasePathMappingsResponse_items - The current page of elements from this collection.
$sel:position:GetBasePathMappings', getBasePathMappingsResponse_position - Undocumented member.
$sel:httpStatus:GetBasePathMappingsResponse', getBasePathMappingsResponse_httpStatus - The response's http status code.
Response Lenses
getBasePathMappingsResponse_items :: Lens' GetBasePathMappingsResponse (Maybe [BasePathMapping]) Source #
The current page of elements from this collection.
getBasePathMappingsResponse_position :: Lens' GetBasePathMappingsResponse (Maybe Text) Source #
Undocumented member.
getBasePathMappingsResponse_httpStatus :: Lens' GetBasePathMappingsResponse Int Source #
The response's http status code.