Skip to content

Guardduty  >  Operations  >  list_invitations

list_invitations

Operation

list_invitations async

list_invitations(input: ListInvitationsInput, plugins: list[Plugin] | None = None) -> ListInvitationsOutput

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

Parameters:

Name Type Description Default
input ListInvitationsInput

An instance of ListInvitationsInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ListInvitationsOutput

An instance of ListInvitationsOutput.

Input

ListInvitationsInput dataclass

Dataclass for ListInvitationsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = None

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.

next_token class-attribute instance-attribute
next_token: str | None = None

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.

Output

ListInvitationsOutput dataclass

Dataclass for ListInvitationsOutput structure.

Attributes

invitations class-attribute instance-attribute
invitations: list[Invitation] | None = None

A list of invitation descriptions.

next_token class-attribute instance-attribute
next_token: str | None = None

The pagination parameter to be used on the next list operation to retrieve more items.