ListInvitations
Lists all GuardDuty membership invitations that were sent to the current AWS account.
Request Syntax
GET /invitation?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
Valid Range: Minimum value of 1. Maximum value of 50.
- NextToken
-
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"invitations": [
{
"accountId": "string",
"invitationId": "string",
"invitedAt": "string",
"relationshipStatus": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- invitations
-
A list of invitation descriptions.
Type: Array of Invitation objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- nextToken
-
The pagination parameter to be used on the next list operation to retrieve more items.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
A bad request exception object.
HTTP Status Code: 400
- InternalServerErrorException
-
An internal server error exception object.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
