| Copyright | (c) 2013-2021 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 |
Amazonka.SecurityHub.ListInvitations
Description
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
This operation returns paginated results.
Synopsis
- data ListInvitations = ListInvitations' {}
- newListInvitations :: ListInvitations
- listInvitations_nextToken :: Lens' ListInvitations (Maybe Text)
- listInvitations_maxResults :: Lens' ListInvitations (Maybe Natural)
- data ListInvitationsResponse = ListInvitationsResponse' {
- invitations :: Maybe [Invitation]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListInvitationsResponse :: Int -> ListInvitationsResponse
- listInvitationsResponse_invitations :: Lens' ListInvitationsResponse (Maybe [Invitation])
- listInvitationsResponse_nextToken :: Lens' ListInvitationsResponse (Maybe Text)
- listInvitationsResponse_httpStatus :: Lens' ListInvitationsResponse Int
Creating a Request
data ListInvitations Source #
See: newListInvitations smart constructor.
Constructors
| ListInvitations' | |
Fields
| |
Instances
newListInvitations :: ListInvitations Source #
Create a value of ListInvitations 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:nextToken:ListInvitations', listInvitations_nextToken - The token that is required for pagination. On your first call to the
ListInvitations operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
$sel:maxResults:ListInvitations', listInvitations_maxResults - The maximum number of items to return in the response.
Request Lenses
listInvitations_nextToken :: Lens' ListInvitations (Maybe Text) Source #
The token that is required for pagination. On your first call to the
ListInvitations operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
listInvitations_maxResults :: Lens' ListInvitations (Maybe Natural) Source #
The maximum number of items to return in the response.
Destructuring the Response
data ListInvitationsResponse Source #
See: newListInvitationsResponse smart constructor.
Constructors
| ListInvitationsResponse' | |
Fields
| |
Instances
newListInvitationsResponse Source #
Create a value of ListInvitationsResponse 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:invitations:ListInvitationsResponse', listInvitationsResponse_invitations - The details of the invitations returned by the operation.
$sel:nextToken:ListInvitations', listInvitationsResponse_nextToken - The pagination token to use to request the next page of results.
$sel:httpStatus:ListInvitationsResponse', listInvitationsResponse_httpStatus - The response's http status code.
Response Lenses
listInvitationsResponse_invitations :: Lens' ListInvitationsResponse (Maybe [Invitation]) Source #
The details of the invitations returned by the operation.
listInvitationsResponse_nextToken :: Lens' ListInvitationsResponse (Maybe Text) Source #
The pagination token to use to request the next page of results.
listInvitationsResponse_httpStatus :: Lens' ListInvitationsResponse Int Source #
The response's http status code.