Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization
operation returns a list of handshake structures. Each structure contains details and status about a handshake.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
This operation can be called only from the organization's master account.
This operation returns paginated results.
- listHandshakesForOrganization :: ListHandshakesForOrganization
- data ListHandshakesForOrganization
- lhfoNextToken :: Lens' ListHandshakesForOrganization (Maybe Text)
- lhfoFilter :: Lens' ListHandshakesForOrganization (Maybe HandshakeFilter)
- lhfoMaxResults :: Lens' ListHandshakesForOrganization (Maybe Natural)
- listHandshakesForOrganizationResponse :: Int -> ListHandshakesForOrganizationResponse
- data ListHandshakesForOrganizationResponse
- lhforsHandshakes :: Lens' ListHandshakesForOrganizationResponse [Handshake]
- lhforsNextToken :: Lens' ListHandshakesForOrganizationResponse (Maybe Text)
- lhforsResponseStatus :: Lens' ListHandshakesForOrganizationResponse Int
Creating a Request
listHandshakesForOrganization :: ListHandshakesForOrganization Source #
Creates a value of ListHandshakesForOrganization
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lhfoNextToken
- Use this parameter if you receive aNextToken
response in a previous request that indicates that there is more output available. Set it to the value of the previous call'sNextToken
response to indicate where the output should continue from.lhfoFilter
- A filter of the handshakes that you want included in the response. The default is all types. Use theActionType
element to limit the output to only a specified type, such asINVITE
,ENABLE-ALL-FEATURES
, orAPPROVE-ALL-FEATURES
. Alternatively, for theENABLE-ALL-FEATURES
handshake that generates a separate child handshake for each member account, you can specify theParentHandshakeId
to see only the handshakes that were generated by that parent request.lhfoMaxResults
- (Optional) Use this to limit the number of results you want included in 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 maximum you specify, theNextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.
data ListHandshakesForOrganization Source #
See: listHandshakesForOrganization
smart constructor.
Request Lenses
lhfoNextToken :: Lens' ListHandshakesForOrganization (Maybe Text) Source #
Use this parameter if you receive a NextToken
response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken
response to indicate where the output should continue from.
lhfoFilter :: Lens' ListHandshakesForOrganization (Maybe HandshakeFilter) Source #
A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType
element to limit the output to only a specified type, such as INVITE
, ENABLE-ALL-FEATURES
, or APPROVE-ALL-FEATURES
. Alternatively, for the ENABLE-ALL-FEATURES
handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId
to see only the handshakes that were generated by that parent request.
lhfoMaxResults :: Lens' ListHandshakesForOrganization (Maybe Natural) Source #
(Optional) Use this to limit the number of results you want included in 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 maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Organizations 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.
Destructuring the Response
listHandshakesForOrganizationResponse Source #
Creates a value of ListHandshakesForOrganizationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lhforsHandshakes
- A list ofHandshake
objects with details about each of the handshakes that are associated with an organization.lhforsNextToken
- If present, this value indicates that there is more output available than is included in the current response. Use this value in theNextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
.lhforsResponseStatus
- -- | The response status code.
data ListHandshakesForOrganizationResponse Source #
See: listHandshakesForOrganizationResponse
smart constructor.
Response Lenses
lhforsHandshakes :: Lens' ListHandshakesForOrganizationResponse [Handshake] Source #
A list of Handshake
objects with details about each of the handshakes that are associated with an organization.
lhforsNextToken :: Lens' ListHandshakesForOrganizationResponse (Maybe Text) Source #
If present, this value indicates that there is more output 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
.
lhforsResponseStatus :: Lens' ListHandshakesForOrganizationResponse Int Source #
- - | The response status code.