GuardDuty / Client / list_invitations

list_invitations#

GuardDuty.Client.list_invitations(**kwargs)#

Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.

Request Syntax

response = client.list_invitations(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – 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.
NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Invitations': [
        {
            'AccountId': 'string',
            'InvitationId': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Invitations (list) –
  
  A list of invitation descriptions.
  - (dict) –
    
    Contains information about the invitation to become a member account.
    - AccountId (string) –
      
      The ID of the account that the invitation was sent from.
    - InvitationId (string) –
      
      The ID of the invitation. This value is used to validate the inviter account to the member account.
    - RelationshipStatus (string) –
      
      The status of the relationship between the inviter and invitee accounts.
    - InvitedAt (string) –
      
      The timestamp when the invitation was sent.
- NextToken (string) –
  
  The pagination parameter to be used on the next list operation to retrieve more items.

Exceptions

GuardDuty.Client.exceptions.BadRequestException
GuardDuty.Client.exceptions.InternalServerErrorException