| 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.Organizations.ListHandshakesForOrganization
Description
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, CANCELED, or EXPIRED
appear in the results of this API for only 30 days after changing to
that state. After that, they're deleted and no longer accessible.
Always check the NextToken response parameter for a null value when
calling a List* operation. These operations can occasionally return an
empty set of results even when there are more results available. The
NextToken response parameter value is null only when there are no
more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
This operation returns paginated results.
Synopsis
- data ListHandshakesForOrganization = ListHandshakesForOrganization' {}
- newListHandshakesForOrganization :: ListHandshakesForOrganization
- listHandshakesForOrganization_filter :: Lens' ListHandshakesForOrganization (Maybe HandshakeFilter)
- listHandshakesForOrganization_maxResults :: Lens' ListHandshakesForOrganization (Maybe Natural)
- listHandshakesForOrganization_nextToken :: Lens' ListHandshakesForOrganization (Maybe Text)
- data ListHandshakesForOrganizationResponse = ListHandshakesForOrganizationResponse' {
- handshakes :: Maybe [Handshake]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListHandshakesForOrganizationResponse :: Int -> ListHandshakesForOrganizationResponse
- listHandshakesForOrganizationResponse_handshakes :: Lens' ListHandshakesForOrganizationResponse (Maybe [Handshake])
- listHandshakesForOrganizationResponse_nextToken :: Lens' ListHandshakesForOrganizationResponse (Maybe Text)
- listHandshakesForOrganizationResponse_httpStatus :: Lens' ListHandshakesForOrganizationResponse Int
Creating a Request
data ListHandshakesForOrganization Source #
See: newListHandshakesForOrganization smart constructor.
Constructors
| ListHandshakesForOrganization' | |
Fields
| |
Instances
newListHandshakesForOrganization :: ListHandshakesForOrganization Source #
Create a value of ListHandshakesForOrganization 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:filter':ListHandshakesForOrganization', listHandshakesForOrganization_filter - 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.
$sel:maxResults:ListHandshakesForOrganization', listHandshakesForOrganization_maxResults - 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
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.
ListHandshakesForOrganization, listHandshakesForOrganization_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
Request Lenses
listHandshakesForOrganization_filter :: 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.
listHandshakesForOrganization_maxResults :: Lens' ListHandshakesForOrganization (Maybe Natural) Source #
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
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.
listHandshakesForOrganization_nextToken :: Lens' ListHandshakesForOrganization (Maybe Text) Source #
The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
Destructuring the Response
data ListHandshakesForOrganizationResponse Source #
See: newListHandshakesForOrganizationResponse smart constructor.
Constructors
| ListHandshakesForOrganizationResponse' | |
Fields
| |
Instances
newListHandshakesForOrganizationResponse Source #
Arguments
| :: Int | |
| -> ListHandshakesForOrganizationResponse |
Create a value of ListHandshakesForOrganizationResponse 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:handshakes:ListHandshakesForOrganizationResponse', listHandshakesForOrganizationResponse_handshakes - A list of Handshake objects with details about each of the handshakes
that are associated with an organization.
ListHandshakesForOrganization, listHandshakesForOrganizationResponse_nextToken - If present, 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.
$sel:httpStatus:ListHandshakesForOrganizationResponse', listHandshakesForOrganizationResponse_httpStatus - The response's http status code.
Response Lenses
listHandshakesForOrganizationResponse_handshakes :: Lens' ListHandshakesForOrganizationResponse (Maybe [Handshake]) Source #
A list of Handshake objects with details about each of the handshakes that are associated with an organization.
listHandshakesForOrganizationResponse_nextToken :: Lens' ListHandshakesForOrganizationResponse (Maybe Text) Source #
If present, 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.
listHandshakesForOrganizationResponse_httpStatus :: Lens' ListHandshakesForOrganizationResponse Int Source #
The response's http status code.