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 the resource shares that you own or that are shared with you.
This operation returns paginated results.
Synopsis
- data GetResourceShares = GetResourceShares' {}
- newGetResourceShares :: ResourceOwner -> GetResourceShares
- getResourceShares_maxResults :: Lens' GetResourceShares (Maybe Natural)
- getResourceShares_name :: Lens' GetResourceShares (Maybe Text)
- getResourceShares_nextToken :: Lens' GetResourceShares (Maybe Text)
- getResourceShares_permissionArn :: Lens' GetResourceShares (Maybe Text)
- getResourceShares_resourceShareArns :: Lens' GetResourceShares (Maybe [Text])
- getResourceShares_resourceShareStatus :: Lens' GetResourceShares (Maybe ResourceShareStatus)
- getResourceShares_tagFilters :: Lens' GetResourceShares (Maybe [TagFilter])
- getResourceShares_resourceOwner :: Lens' GetResourceShares ResourceOwner
- data GetResourceSharesResponse = GetResourceSharesResponse' {
- nextToken :: Maybe Text
- resourceShares :: Maybe [ResourceShare]
- httpStatus :: Int
- newGetResourceSharesResponse :: Int -> GetResourceSharesResponse
- getResourceSharesResponse_nextToken :: Lens' GetResourceSharesResponse (Maybe Text)
- getResourceSharesResponse_resourceShares :: Lens' GetResourceSharesResponse (Maybe [ResourceShare])
- getResourceSharesResponse_httpStatus :: Lens' GetResourceSharesResponse Int
Creating a Request
data GetResourceShares Source #
See: newGetResourceShares
smart constructor.
GetResourceShares' | |
|
Instances
Create a value of GetResourceShares
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:GetResourceShares'
, getResourceShares_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.
GetResourceShares
, getResourceShares_name
- Specifies the name of an individual resource share that you want to
retrieve details about.
GetResourceShares
, getResourceShares_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:permissionArn:GetResourceShares'
, getResourceShares_permissionArn
- Specifies that you want to retrieve details of only those resource
shares that use the RAM permission with this
Amazon Resoure Name (ARN).
$sel:resourceShareArns:GetResourceShares'
, getResourceShares_resourceShareArns
- Specifies the
Amazon Resource Names (ARNs)
of individual resource shares that you want information about.
$sel:resourceShareStatus:GetResourceShares'
, getResourceShares_resourceShareStatus
- Specifies that you want to retrieve details of only those resource
shares that have this status.
$sel:tagFilters:GetResourceShares'
, getResourceShares_tagFilters
- Specifies that you want to retrieve details of only those resource
shares that match the specified tag keys and values.
$sel:resourceOwner:GetResourceShares'
, getResourceShares_resourceOwner
- Specifies that you want to retrieve details of only those resource
shares that match the following:
SELF
– resource shares that your account shares with other accountsOTHER-ACCOUNTS
– resource shares that other accounts share with your account
Request Lenses
getResourceShares_maxResults :: Lens' GetResourceShares (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.
getResourceShares_name :: Lens' GetResourceShares (Maybe Text) Source #
Specifies the name of an individual resource share that you want to retrieve details about.
getResourceShares_nextToken :: Lens' GetResourceShares (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.
getResourceShares_permissionArn :: Lens' GetResourceShares (Maybe Text) Source #
Specifies that you want to retrieve details of only those resource shares that use the RAM permission with this Amazon Resoure Name (ARN).
getResourceShares_resourceShareArns :: Lens' GetResourceShares (Maybe [Text]) Source #
Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
getResourceShares_resourceShareStatus :: Lens' GetResourceShares (Maybe ResourceShareStatus) Source #
Specifies that you want to retrieve details of only those resource shares that have this status.
getResourceShares_tagFilters :: Lens' GetResourceShares (Maybe [TagFilter]) Source #
Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.
getResourceShares_resourceOwner :: Lens' GetResourceShares ResourceOwner Source #
Specifies that you want to retrieve details of only those resource shares that match the following:
SELF
– resource shares that your account shares with other accountsOTHER-ACCOUNTS
– resource shares that other accounts share with your account
Destructuring the Response
data GetResourceSharesResponse Source #
See: newGetResourceSharesResponse
smart constructor.
GetResourceSharesResponse' | |
|
Instances
newGetResourceSharesResponse Source #
Create a value of GetResourceSharesResponse
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:
GetResourceShares
, getResourceSharesResponse_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:resourceShares:GetResourceSharesResponse'
, getResourceSharesResponse_resourceShares
- An array of objects that contain the information about the resource
shares.
$sel:httpStatus:GetResourceSharesResponse'
, getResourceSharesResponse_httpStatus
- The response's http status code.
Response Lenses
getResourceSharesResponse_nextToken :: Lens' GetResourceSharesResponse (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.
getResourceSharesResponse_resourceShares :: Lens' GetResourceSharesResponse (Maybe [ResourceShare]) Source #
An array of objects that contain the information about the resource shares.
getResourceSharesResponse_httpStatus :: Lens' GetResourceSharesResponse Int Source #
The response's http status code.