Macie2 / Client / list_members

list_members#

Macie2.Client.list_members(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_members(
    maxResults=123,
    nextToken='string',
    onlyAssociated='string'
)
Parameters:

  • maxResults (integer) – The maximum number of items to include in each page of a paginated response.

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

  • onlyAssociated (string) – Specifies which accounts to include in the response, based on the status of an account’s relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.

Return type:

dict

Returns:

Response Syntax

{
    'members': [
        {
            'accountId': 'string',
            'administratorAccountId': 'string',
            'arn': 'string',
            'email': 'string',
            'invitedAt': datetime(2015, 1, 1),
            'masterAccountId': 'string',
            'relationshipStatus': 'Enabled'|'Paused'|'Invited'|'Created'|'Removed'|'Resigned'|'EmailVerificationInProgress'|'EmailVerificationFailed'|'RegionDisabled'|'AccountSuspended',
            'tags': {
                'string': 'string'
            },
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    The request succeeded.

    • members (list) –

      An array of objects, one for each account that’s associated with the administrator account and matches the criteria specified in the request.

      • (dict) –

        Provides information about an account that’s associated with an Amazon Macie administrator account.

        • accountId (string) –

          The Amazon Web Services account ID for the account.

        • administratorAccountId (string) –

          The Amazon Web Services account ID for the administrator account.

        • arn (string) –

          The Amazon Resource Name (ARN) of the account.

        • email (string) –

          The email address for the account. This value is null if the account is associated with the administrator account through Organizations.

        • invitedAt (datetime) –

          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 membership invitation hasn’t been sent to the account.

        • masterAccountId (string) –

          (Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

        • relationshipStatus (string) –

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

        • tags (dict) –

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

          • (string) –

            • (string) –

        • updatedAt (datetime) –

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

Exceptions