Skip to content

get_lists_metadata async

get_lists_metadata(
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
    name: Optional[noDashIdentifier] = None,
    next_token: Optional[nextToken] = None,
    max_results: Optional[ListsMetadataMaxResults] = None,
) -> GetListsMetadataResult

Gets the metadata of either all the lists under the account or the specified list.

Parameters:

Raises:

  • AccessDeniedException –

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • InternalServerException –

    An exception indicating an internal server error.

  • ResourceNotFoundException –

    An exception indicating the specified resource was not found.

  • ThrottlingException –

    An exception indicating a throttling error.

  • ValidationException –

    An exception indicating a specified value is not allowed.

  • UnknownServiceError –

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

Source code in docs_src/capo_frauddetector/_services/async_fraud_detector.py
async def get_lists_metadata(
    self,
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
    name: Optional[
        "capo_frauddetector.types.no_dash_identifier.noDashIdentifier"
    ] = None,
    next_token: Optional["capo_frauddetector.types.next_token.nextToken"] = None,
    max_results: Optional[
        "capo_frauddetector.types.lists_metadata_max_results.ListsMetadataMaxResults"
    ] = None,
) -> "capo_frauddetector.types.get_lists_metadata_result.GetListsMetadataResult":
    """<p> Gets the metadata of either all the lists under the account or the specified list. </p>

    Args:
        name: <p> The name of the list. </p>
        next_token: <p> The next token for the subsequent request. </p>
        max_results: <p> The maximum number of objects to return for the request. </p>

    Raises:
        capo_frauddetector.errors.access_denied_exception.AccessDeniedException: <p>An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as <code>PutExternalModel</code>, that specifies a role that is not in your account.</p>
        capo_frauddetector.errors.internal_server_exception.InternalServerException: <p>An exception indicating an internal server error.</p>
        capo_frauddetector.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception indicating the specified resource was not found.</p>
        capo_frauddetector.errors.throttling_exception.ThrottlingException: <p>An exception indicating a throttling error.</p>
        capo_frauddetector.errors.validation_exception.ValidationException: <p>An exception indicating a specified value is not allowed.</p>
        capo_frauddetector.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_frauddetector.types.get_lists_metadata_request.GetListsMetadataRequest]",
    ) -> AsyncOperationResponse[
        "capo_frauddetector.types.get_lists_metadata_result.GetListsMetadataResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.get_lists_metadata

        (
            output,
            http_response,
        ) = await capo_frauddetector._operations.aws_hawks_nest_service_facade.get_lists_metadata.async_get_lists_metadata(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetListsMetadata")
    )
    input_: capo_frauddetector.types.get_lists_metadata_request.GetListsMetadataRequest = {}
    if name is not None:
        input_["name"] = name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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