| 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.CloudFront.ListDistributionsByKeyGroup
Description
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the
response. If the total number of items in the list exceeds the maximum
that you specify, or the default maximum, the response is paginated. To
get the next page of items, send a subsequent request that specifies the
NextMarker value from the current response as the Marker value in
the subsequent request.
Synopsis
- data ListDistributionsByKeyGroup = ListDistributionsByKeyGroup' {}
- newListDistributionsByKeyGroup :: Text -> ListDistributionsByKeyGroup
- listDistributionsByKeyGroup_marker :: Lens' ListDistributionsByKeyGroup (Maybe Text)
- listDistributionsByKeyGroup_maxItems :: Lens' ListDistributionsByKeyGroup (Maybe Text)
- listDistributionsByKeyGroup_keyGroupId :: Lens' ListDistributionsByKeyGroup Text
- data ListDistributionsByKeyGroupResponse = ListDistributionsByKeyGroupResponse' {}
- newListDistributionsByKeyGroupResponse :: Int -> ListDistributionsByKeyGroupResponse
- listDistributionsByKeyGroupResponse_distributionIdList :: Lens' ListDistributionsByKeyGroupResponse (Maybe DistributionIdList)
- listDistributionsByKeyGroupResponse_httpStatus :: Lens' ListDistributionsByKeyGroupResponse Int
Creating a Request
data ListDistributionsByKeyGroup Source #
See: newListDistributionsByKeyGroup smart constructor.
Constructors
| ListDistributionsByKeyGroup' | |
Fields
| |
Instances
newListDistributionsByKeyGroup Source #
Create a value of ListDistributionsByKeyGroup 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:marker:ListDistributionsByKeyGroup', listDistributionsByKeyGroup_marker - Use this field when paginating results to indicate where to begin in
your list of distribution IDs. The response includes distribution IDs in
the list that occur after the marker. To get the next page of the list,
set this field’s value to the value of NextMarker from the current
page’s response.
$sel:maxItems:ListDistributionsByKeyGroup', listDistributionsByKeyGroup_maxItems - The maximum number of distribution IDs that you want in the response.
$sel:keyGroupId:ListDistributionsByKeyGroup', listDistributionsByKeyGroup_keyGroupId - The ID of the key group whose associated distribution IDs you are
listing.
Request Lenses
listDistributionsByKeyGroup_marker :: Lens' ListDistributionsByKeyGroup (Maybe Text) Source #
Use this field when paginating results to indicate where to begin in
your list of distribution IDs. The response includes distribution IDs in
the list that occur after the marker. To get the next page of the list,
set this field’s value to the value of NextMarker from the current
page’s response.
listDistributionsByKeyGroup_maxItems :: Lens' ListDistributionsByKeyGroup (Maybe Text) Source #
The maximum number of distribution IDs that you want in the response.
listDistributionsByKeyGroup_keyGroupId :: Lens' ListDistributionsByKeyGroup Text Source #
The ID of the key group whose associated distribution IDs you are listing.
Destructuring the Response
data ListDistributionsByKeyGroupResponse Source #
See: newListDistributionsByKeyGroupResponse smart constructor.
Constructors
| ListDistributionsByKeyGroupResponse' | |
Fields
| |
Instances
newListDistributionsByKeyGroupResponse Source #
Arguments
| :: Int | |
| -> ListDistributionsByKeyGroupResponse |
Create a value of ListDistributionsByKeyGroupResponse 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:distributionIdList:ListDistributionsByKeyGroupResponse', listDistributionsByKeyGroupResponse_distributionIdList - Undocumented member.
$sel:httpStatus:ListDistributionsByKeyGroupResponse', listDistributionsByKeyGroupResponse_httpStatus - The response's http status code.
Response Lenses
listDistributionsByKeyGroupResponse_distributionIdList :: Lens' ListDistributionsByKeyGroupResponse (Maybe DistributionIdList) Source #
Undocumented member.
listDistributionsByKeyGroupResponse_httpStatus :: Lens' ListDistributionsByKeyGroupResponse Int Source #
The response's http status code.