Inspector2 / Client / list_members

list_members#

Inspector2.Client.list_members(**kwargs)#

List members associated with the Amazon Inspector delegated administrator for your organization.

See also: AWS API Documentation

Request Syntax

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

  • maxResults (integer) – The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

  • nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

  • onlyAssociated (boolean) – Specifies whether to list only currently associated members if True or to list all members within the organization if False.

Return type:

dict

Returns:

Response Syntax

{
    'members': [
        {
            'accountId': 'string',
            'delegatedAdminAccountId': 'string',
            'relationshipStatus': 'CREATED'|'INVITED'|'DISABLED'|'ENABLED'|'REMOVED'|'RESIGNED'|'DELETED'|'EMAIL_VERIFICATION_IN_PROGRESS'|'EMAIL_VERIFICATION_FAILED'|'REGION_DISABLED'|'ACCOUNT_SUSPENDED'|'CANNOT_CREATE_DETECTOR_IN_ORG_MASTER',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • members (list) –

      An object that contains details for each member account.

      • (dict) –

        Details on a member account in your organization.

        • accountId (string) –

          The Amazon Web Services account ID of the member account.

        • delegatedAdminAccountId (string) –

          The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.

        • relationshipStatus (string) –

          The status of the member account.

        • updatedAt (datetime) –

          A timestamp showing when the status of this member was last updated.

    • nextToken (string) –

      The pagination parameter to be used on the next list operation to retrieve more items.

Exceptions