Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves details about invitations that you have received for resource shares.
This operation returns paginated results.
Synopsis
- data GetResourceShareInvitations = GetResourceShareInvitations' {}
- newGetResourceShareInvitations :: GetResourceShareInvitations
- getResourceShareInvitations_maxResults :: Lens' GetResourceShareInvitations (Maybe Natural)
- getResourceShareInvitations_nextToken :: Lens' GetResourceShareInvitations (Maybe Text)
- getResourceShareInvitations_resourceShareArns :: Lens' GetResourceShareInvitations (Maybe [Text])
- getResourceShareInvitations_resourceShareInvitationArns :: Lens' GetResourceShareInvitations (Maybe [Text])
- data GetResourceShareInvitationsResponse = GetResourceShareInvitationsResponse' {}
- newGetResourceShareInvitationsResponse :: Int -> GetResourceShareInvitationsResponse
- getResourceShareInvitationsResponse_nextToken :: Lens' GetResourceShareInvitationsResponse (Maybe Text)
- getResourceShareInvitationsResponse_resourceShareInvitations :: Lens' GetResourceShareInvitationsResponse (Maybe [ResourceShareInvitation])
- getResourceShareInvitationsResponse_httpStatus :: Lens' GetResourceShareInvitationsResponse Int
Creating a Request
data GetResourceShareInvitations Source #
See: newGetResourceShareInvitations
smart constructor.
GetResourceShareInvitations' | |
|
Instances
newGetResourceShareInvitations :: GetResourceShareInvitations Source #
Create a value of GetResourceShareInvitations
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:maxResults:GetResourceShareInvitations'
, getResourceShareInvitations_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
GetResourceShareInvitations
, getResourceShareInvitations_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
$sel:resourceShareArns:GetResourceShareInvitations'
, getResourceShareInvitations_resourceShareArns
- Specifies that you want details about invitations only for the resource
shares described by this list of
Amazon Resource Names (ARNs)
$sel:resourceShareInvitationArns:GetResourceShareInvitations'
, getResourceShareInvitations_resourceShareInvitationArns
- Specifies the
Amazon Resource Names (ARNs)
of the resource share invitations you want information about.
Request Lenses
getResourceShareInvitations_maxResults :: Lens' GetResourceShareInvitations (Maybe Natural) Source #
Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
getResourceShareInvitations_nextToken :: Lens' GetResourceShareInvitations (Maybe Text) Source #
Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
getResourceShareInvitations_resourceShareArns :: Lens' GetResourceShareInvitations (Maybe [Text]) Source #
Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)
getResourceShareInvitations_resourceShareInvitationArns :: Lens' GetResourceShareInvitations (Maybe [Text]) Source #
Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.
Destructuring the Response
data GetResourceShareInvitationsResponse Source #
See: newGetResourceShareInvitationsResponse
smart constructor.
GetResourceShareInvitationsResponse' | |
|
Instances
newGetResourceShareInvitationsResponse Source #
Create a value of GetResourceShareInvitationsResponse
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:
GetResourceShareInvitations
, getResourceShareInvitationsResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:resourceShareInvitations:GetResourceShareInvitationsResponse'
, getResourceShareInvitationsResponse_resourceShareInvitations
- An array of objects that contain the details about the invitations.
$sel:httpStatus:GetResourceShareInvitationsResponse'
, getResourceShareInvitationsResponse_httpStatus
- The response's http status code.
Response Lenses
getResourceShareInvitationsResponse_nextToken :: Lens' GetResourceShareInvitationsResponse (Maybe Text) Source #
If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
getResourceShareInvitationsResponse_resourceShareInvitations :: Lens' GetResourceShareInvitationsResponse (Maybe [ResourceShareInvitation]) Source #
An array of objects that contain the details about the invitations.
getResourceShareInvitationsResponse_httpStatus :: Lens' GetResourceShareInvitationsResponse Int Source #
The response's http status code.