list_members ¶

list_members(
    *,
    config_overrides: Optional[Macie2ClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
    only_associated: Optional[__string] = None,
) -> ListMembersResponse

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

Parameters:

max_results (Optional[MaxResults], default: None ) –

The maximum number of items to include in each page of a paginated response.
next_token (Optional[__string], default: None ) –

The nextToken string that specifies which page of results to return in a paginated response.
only_associated (Optional[__string], default: None ) –

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.

Raises:

AccessDeniedException –

Provides information about an error that occurred due to insufficient access to a specified resource.
ConflictException –

Provides information about an error that occurred due to a versioning conflict for a specified resource.
InternalServerException –

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.
ResourceNotFoundException –

Provides information about an error that occurred because a specified resource wasn't found.
ServiceQuotaExceededException –

Provides information about an error that occurred due to one or more service quotas for an account.
ThrottlingException –

Provides information about an error that occurred because too many requests were sent during a certain amount of time.
ValidationException –

Provides information about an error that occurred due to a syntax error in a request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_macie2/_services/macie2.py

def list_members(
    self,
    *,
    config_overrides: Optional[Macie2ClientConfig] = None,
    max_results: Optional["capo_macie2.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_macie2.types.__string.__string"] = None,
    only_associated: Optional["capo_macie2.types.__string.__string"] = None,
) -> "capo_macie2.types.list_members_response.ListMembersResponse":
    """<p>Retrieves information about the accounts that are associated with an Amazon Macie administrator account.</p>

    Args:
        max_results: <p>The maximum number of items to include in each page of a paginated response.</p>
        next_token: <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
        only_associated: <p>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.</p>

    Raises:
        capo_macie2.errors.access_denied_exception.AccessDeniedException: <p>Provides information about an error that occurred due to insufficient access to a specified resource.</p>
        capo_macie2.errors.conflict_exception.ConflictException: <p>Provides information about an error that occurred due to a versioning conflict for a specified resource.</p>
        capo_macie2.errors.internal_server_exception.InternalServerException: <p>Provides information about an error that occurred due to an unknown internal server error, exception, or failure.</p>
        capo_macie2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Provides information about an error that occurred because a specified resource wasn't found.</p>
        capo_macie2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Provides information about an error that occurred due to one or more service quotas for an account.</p>
        capo_macie2.errors.throttling_exception.ThrottlingException: <p>Provides information about an error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_macie2.errors.validation_exception.ValidationException: <p>Provides information about an error that occurred due to a syntax error in a request.</p>
        capo_macie2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_macie2.types.list_members_request.ListMembersRequest]",
    ) -> OperationResponse[
        "capo_macie2.types.list_members_response.ListMembersResponse"
    ]:
        import capo_macie2._operations.macie2.list_members

        output, http_response = (
            capo_macie2._operations.macie2.list_members.list_members(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMembers")
    )
    input_: capo_macie2.types.list_members_request.ListMembersRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if only_associated is not None:
        input_["only_associated"] = only_associated

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output