[ aws . guardduty ]

get-members

Description

Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--detector-id (string)

The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

--account-ids (list)

A list of account IDs of the GuardDuty member accounts that you want to describe.

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

Output

Members -> (list)

A list of members.

(structure)

Contains information about the member account.

AccountId -> (string)

The ID of the member account.

DetectorId -> (string)

The detector ID of the member account.

MasterId -> (string)

The master account ID.

Email -> (string)

The email address of the member account.

RelationshipStatus -> (string)

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

InvitedAt -> (string)

The timestamp when the invitation was sent.

UpdatedAt -> (string)

The last-updated timestamp of the member.

UnprocessedAccounts -> (list)

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

(structure)

Contains information about the accounts that weren’t processed.

AccountId -> (string)

The AWS account ID.

Result -> (string)

A reason why the account hasn’t been processed.