[ aws . securityhub ]

invite-members

Description

Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.

Before you can use this action to invite a member, you must first use the `` CreateMembers `` action to create the member account in Security Hub.

When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from the member account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  invite-members
[--account-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--account-ids (list)

The list of account IDs of the AWS accounts to invite to Security Hub as members.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To send invitations to member accounts

The following invite-members example sends invitations to the specified member accounts.

aws securityhub invite-members \
    --account-ids "123456789111" "123456789222"

Output:

{
    "UnprocessedAccounts": []
}

For more information, see Master and member accounts in the AWS Security Hub User Guide.

Output

UnprocessedAccounts -> (list)

The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.

(structure)

Details about the account that was not processed.

AccountId -> (string)

An AWS account ID of the account that was not processed.

ProcessingResult -> (string)

The reason that the account was not processed.