| 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 |
Amazonka.RAM.ListPendingInvitationResources
Description
Lists the resources in a resource share that is shared with you but for
which the invitation is still PENDING. That means that you haven't
accepted or rejected the invitation and the invitation hasn't expired.
Synopsis
- data ListPendingInvitationResources = ListPendingInvitationResources' {}
- newListPendingInvitationResources :: Text -> ListPendingInvitationResources
- listPendingInvitationResources_maxResults :: Lens' ListPendingInvitationResources (Maybe Natural)
- listPendingInvitationResources_nextToken :: Lens' ListPendingInvitationResources (Maybe Text)
- listPendingInvitationResources_resourceRegionScope :: Lens' ListPendingInvitationResources (Maybe ResourceRegionScopeFilter)
- listPendingInvitationResources_resourceShareInvitationArn :: Lens' ListPendingInvitationResources Text
- data ListPendingInvitationResourcesResponse = ListPendingInvitationResourcesResponse' {}
- newListPendingInvitationResourcesResponse :: Int -> ListPendingInvitationResourcesResponse
- listPendingInvitationResourcesResponse_nextToken :: Lens' ListPendingInvitationResourcesResponse (Maybe Text)
- listPendingInvitationResourcesResponse_resources :: Lens' ListPendingInvitationResourcesResponse (Maybe [Resource])
- listPendingInvitationResourcesResponse_httpStatus :: Lens' ListPendingInvitationResourcesResponse Int
Creating a Request
data ListPendingInvitationResources Source #
See: newListPendingInvitationResources smart constructor.
Constructors
| ListPendingInvitationResources' | |
Fields
| |
Instances
newListPendingInvitationResources Source #
Create a value of ListPendingInvitationResources 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:ListPendingInvitationResources', listPendingInvitationResources_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.
ListPendingInvitationResources, listPendingInvitationResources_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.
ListPendingInvitationResources, listPendingInvitationResources_resourceRegionScope - Specifies that you want the results to include only resources that have
the specified scope.
ALL– the results include both global and regional resources or resource types.GLOBAL– the results include only global resources or resource types.REGIONAL– the results include only regional resources or resource types.
The default value is ALL.
ListPendingInvitationResources, listPendingInvitationResources_resourceShareInvitationArn - Specifies the
Amazon Resoure Name (ARN)
of the invitation. You can use GetResourceShareInvitations to find the
ARN of the invitation.
Request Lenses
listPendingInvitationResources_maxResults :: Lens' ListPendingInvitationResources (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.
listPendingInvitationResources_nextToken :: Lens' ListPendingInvitationResources (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.
listPendingInvitationResources_resourceRegionScope :: Lens' ListPendingInvitationResources (Maybe ResourceRegionScopeFilter) Source #
Specifies that you want the results to include only resources that have the specified scope.
ALL– the results include both global and regional resources or resource types.GLOBAL– the results include only global resources or resource types.REGIONAL– the results include only regional resources or resource types.
The default value is ALL.
listPendingInvitationResources_resourceShareInvitationArn :: Lens' ListPendingInvitationResources Text Source #
Specifies the Amazon Resoure Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.
Destructuring the Response
data ListPendingInvitationResourcesResponse Source #
See: newListPendingInvitationResourcesResponse smart constructor.
Constructors
| ListPendingInvitationResourcesResponse' | |
Fields
| |
Instances
newListPendingInvitationResourcesResponse Source #
Arguments
| :: Int | |
| -> ListPendingInvitationResourcesResponse |
Create a value of ListPendingInvitationResourcesResponse 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:
ListPendingInvitationResources, listPendingInvitationResourcesResponse_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:resources:ListPendingInvitationResourcesResponse', listPendingInvitationResourcesResponse_resources - An array of objects that contain the information about the resources
included the specified resource share.
$sel:httpStatus:ListPendingInvitationResourcesResponse', listPendingInvitationResourcesResponse_httpStatus - The response's http status code.
Response Lenses
listPendingInvitationResourcesResponse_nextToken :: Lens' ListPendingInvitationResourcesResponse (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.
listPendingInvitationResourcesResponse_resources :: Lens' ListPendingInvitationResourcesResponse (Maybe [Resource]) Source #
An array of objects that contain the information about the resources included the specified resource share.
listPendingInvitationResourcesResponse_httpStatus :: Lens' ListPendingInvitationResourcesResponse Int Source #
The response's http status code.