List Invitations

securityhub_list_invitations

R Documentation

Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account¶

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.

Usage¶

securityhub_list_invitations(MaxResults, NextToken)

Arguments¶

MaxResults

The maximum number of items to return in the response.

NextToken

The token that is required for pagination. On your first call to the list_invitations 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.

Value¶

A list with the following syntax:

list(
  Invitations = list(
    list(
      AccountId = "string",
      InvitationId = "string",
      InvitedAt = as.POSIXct(
        "2015-01-01"
      ),
      MemberStatus = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_invitations(
  MaxResults = 123,
  NextToken = "string"
)

Examples¶

## Not run: 
# The following example returns a list of Security Hub member invitations
# sent to the calling AWS account. Only accounts that are invited manually
# use this operation. It's not for use by accounts that are managed
# through AWS Organizations.
svc$list_invitations()

## End(Not run)