Skip to content

describe_lookup_tables async

describe_lookup_tables(
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    lookup_table_name_prefix: Optional[LookupTableName] = None,
    max_results: Optional[DescribeLookupTablesMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeLookupTablesResponse

Retrieves metadata about lookup tables in your account. You can optionally filter the results by table name prefix. Results are sorted by table name in ascending order.

Parameters:

  • lookup_table_name_prefix (Optional[LookupTableName], default: None ) –

    A prefix to filter lookup tables by name. Only tables whose names start with this prefix are returned. If you don't specify a prefix, all tables in the account and Region are returned.

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

    The maximum number of lookup tables to return in the response. The default value is 50 and the maximum value is 100.

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

    The token for the next set of items to return. (You received this token from a previous call.)

Raises:

Source code in docs_src/capo_cloudwatch_logs/_services/async_cloud_watch_logs.py
async def describe_lookup_tables(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    lookup_table_name_prefix: Optional[
        "capo_cloudwatch_logs.types.lookup_table_name.LookupTableName"
    ] = None,
    max_results: Optional[
        "capo_cloudwatch_logs.types.describe_lookup_tables_max_results.DescribeLookupTablesMaxResults"
    ] = None,
    next_token: Optional["capo_cloudwatch_logs.types.next_token.NextToken"] = None,
) -> "capo_cloudwatch_logs.types.describe_lookup_tables_response.DescribeLookupTablesResponse":
    """<p>Retrieves metadata about lookup tables in your account. You can optionally filter the results by table name prefix. Results are sorted by table name in ascending order.</p>

    Args:
        lookup_table_name_prefix: <p>A prefix to filter lookup tables by name. Only tables whose names start with this prefix are returned. If you don't specify a prefix, all tables in the account and Region are returned.</p>
        max_results: <p>The maximum number of lookup tables to return in the response. The default value is 50 and the maximum value is 100.</p>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>

    Raises:
        capo_cloudwatch_logs.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_cloudwatch_logs.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_cloudwatch_logs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_cloudwatch_logs.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service cannot complete the request.</p>
        capo_cloudwatch_logs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch_logs.types.describe_lookup_tables_request.DescribeLookupTablesRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch_logs.types.describe_lookup_tables_response.DescribeLookupTablesResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_lookup_tables

        (
            output,
            http_response,
        ) = await capo_cloudwatch_logs._operations.logs_20140328.describe_lookup_tables.async_describe_lookup_tables(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLookupTables")
    )
    input_: capo_cloudwatch_logs.types.describe_lookup_tables_request.DescribeLookupTablesRequest = {}
    if lookup_table_name_prefix is not None:
        input_["lookup_table_name_prefix"] = lookup_table_name_prefix
    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