Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . macie2 ]

list-members

Description

Retrieves information about the accounts that are associated with an Amazon Macie master account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-members
[--max-results <value>]
[--next-token <value>]
[--only-associated <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of items to include in each page of a paginated response.

--next-token (string)

The nextToken string that specifies which page of results to return in a paginated response.

--only-associated (string)

Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Output

members -> (list)

An array of objects, one for each account that's associated with the master account and meets the criteria specified by the onlyAssociated request parameter.

(structure)

Provides information about an account that's associated with an Amazon Macie master account.

accountId -> (string)

The AWS account ID for the account.

arn -> (string)

The Amazon Resource Name (ARN) of the account.

email -> (string)

The email address for the account.

invitedAt -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

masterAccountId -> (string)

The AWS account ID for the master account.

relationshipStatus -> (string)

The current status of the relationship between the account and the master account.

tags -> (map)

A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.

key -> (string)

value -> (string)

updatedAt -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.

nextToken -> (string)

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.