Skip to content

list_custom_data_identifiers async

list_custom_data_identifiers(
    *,
    config_overrides: Optional[AsyncMacie2ClientConfig] = None,
    max_results: Optional[__integer] = None,
    next_token: Optional[__string] = None,
) -> ListCustomDataIdentifiersResponse

Retrieves a subset of information about the custom data identifiers for an account.

Parameters:

  • max_results (Optional[__integer], default: None ) –

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

  • next_token (Optional[__string], default: None ) –

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

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/async_macie2.py
async def list_custom_data_identifiers(
    self,
    *,
    config_overrides: Optional[AsyncMacie2ClientConfig] = None,
    max_results: Optional["capo_macie2.types.__integer.__integer"] = None,
    next_token: Optional["capo_macie2.types.__string.__string"] = None,
) -> "capo_macie2.types.list_custom_data_identifiers_response.ListCustomDataIdentifiersResponse":
    """<p>Retrieves a subset of information about the custom data identifiers for an account.</p>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_macie2.types.list_custom_data_identifiers_request.ListCustomDataIdentifiersRequest]",
    ) -> AsyncOperationResponse[
        "capo_macie2.types.list_custom_data_identifiers_response.ListCustomDataIdentifiersResponse"
    ]:
        import capo_macie2._operations.macie2.list_custom_data_identifiers

        (
            output,
            http_response,
        ) = await capo_macie2._operations.macie2.list_custom_data_identifiers.async_list_custom_data_identifiers(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCustomDataIdentifiers")
    )
    input_: capo_macie2.types.list_custom_data_identifiers_request.ListCustomDataIdentifiersRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output