get-members¶

Description¶

Returns the details for the Security Hub member accounts for the specified account IDs.

A master account can be either a delegated Security Hub administrator account for an organization or a master account that enabled Security Hub manually.

The results include both member accounts that are in an organization and accounts that were invited manually.

Synopsis¶

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

Options¶

--account-ids (list)

The list of account IDs for the Security Hub member accounts to return the details for.

(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.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To retrieve information about selected member accounts

The following get-members example retrieves information about the specified member accounts.

aws securityhub get-members \
    --account-ids "444455556666" "777788889999"

Output:

{
    "Members": [
        {
            "AccountId": "123456789111",
            "InvitedAt": 2020-06-01T20:15:15.289000+00:00,
            "MasterId": "123456789012",
            "MemberStatus": "ASSOCIATED",
            "UpdatedAt": 2020-06-01T20:15:15.289000+00:00
        },
        {
            "AccountId": "123456789222",
            "InvitedAt": 2020-06-01T20:15:15.289000+00:00,
            "MasterId": "123456789012",
            "MemberStatus": "ASSOCIATED",
            "UpdatedAt": 2020-06-01T20:15:15.289000+00:00
        }
    ],
    "UnprocessedAccounts": [ ]
}

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

Output¶

Members -> (list)

The list of details about the Security Hub member accounts.

(structure)

The details about a member account.

AccountId -> (string)

The AWS account ID of the member account.

Email -> (string)

The email address of the member account.

MasterId -> (string)

The AWS account ID of the Security Hub master account associated with this member account.

MemberStatus -> (string)

The status of the relationship between the member account and its master account.

The status can have one of the following values:

CREATED - Indicates that the master account added the member account, but has not yet invited the member account.

INVITED - Indicates that the master account invited the member account. The member account has not yet responded to the invitation.

ENABLED - Indicates that the member account is currently active. For manually invited member accounts, indicates that the member account accepted the invitation.

REMOVED - Indicates that the master account disassociated the member account.

RESIGNED - Indicates that the member account disassociated themselves from the master account.

DELETED - Indicates that the master account deleted the member account.

InvitedAt -> (timestamp)

A timestamp for the date and time when the invitation was sent to the member account.

UpdatedAt -> (timestamp)

The timestamp for the date and time when the member account was updated.

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.

Table of Contents

Feedback

User Guide