list-members¶

Description¶

Lists details about all member accounts for the current Security Hub administrator account.

The results include both member accounts that belong to an organization and member accounts that were invited manually.

Synopsis¶

  list-members
[--only-associated | --no-only-associated]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--only-associated | --no-only-associated (boolean)

Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE .

If OnlyAssociated is set to TRUE , the response includes member accounts whose relationship status with the administrator account is set to ENABLED .

If OnlyAssociated is set to FALSE , the response includes all existing member accounts.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 a list of member accounts

The following list-members example returns the list of member accounts for the requesting administrator account.

aws securityhub list-members

Output:

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

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

Output¶

Members -> (list)

Member details returned by the operation.

(structure)

The details about a member account.

AccountId -> (string)

The Amazon Web Services account ID of the member account.

Email -> (string)

The email address of the member account.

MasterId -> (string)

This is replaced by AdministratorID .

The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

AdministratorId -> (string)

The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

MemberStatus -> (string)

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

The status can have one of the following values:

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

INVITED - Indicates that the administrator 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 administrator account disassociated the member account.

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

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

ACCOUNT_SUSPENDED - Indicates that an organization account was suspended from Amazon Web Services at the same time that the administrator account tried to enable the organization account as a 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.

NextToken -> (string)

The pagination token to use to request the next page of results.

Table of Contents

Feedback

User Guide