get_api_keys `async` ¶

get_api_keys(
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    position: Optional[String] = None,
    limit: Optional[NullableInteger] = None,
    name_query: Optional[String] = None,
    customer_id: Optional[String] = None,
    include_values: Optional[NullableBoolean] = None,
) -> ApiKeys

Gets information about the current ApiKeys resource.

Parameters:

position (Optional[String], default: None ) –

The current pagination position in the paged result set.
limit (Optional[NullableInteger], default: None ) –

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
name_query (Optional[String], default: None ) –

The name of queried API keys.
customer_id (Optional[String], default: None ) –

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
include_values (Optional[NullableBoolean], default: None ) –

A boolean flag to specify whether (true) or not (false) the result contains key values.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

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

Source code in docs_src/capo_api_gateway/_services/async_api_gateway.py

async def get_api_keys(
    self,
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    position: Optional["capo_api_gateway.types.string.String"] = None,
    limit: Optional[
        "capo_api_gateway.types.nullable_integer.NullableInteger"
    ] = None,
    name_query: Optional["capo_api_gateway.types.string.String"] = None,
    customer_id: Optional["capo_api_gateway.types.string.String"] = None,
    include_values: Optional[
        "capo_api_gateway.types.nullable_boolean.NullableBoolean"
    ] = None,
) -> "capo_api_gateway.types.api_keys.ApiKeys":
    """<p>Gets information about the current ApiKeys resource.</p>

    Args:
        position: <p>The current pagination position in the paged result set.</p>
        limit: <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
        name_query: <p>The name of queried API keys.</p>
        customer_id: <p>The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.</p>
        include_values: <p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains key values.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_api_gateway.types.get_api_keys_request.GetApiKeysRequest]",
    ) -> AsyncOperationResponse["capo_api_gateway.types.api_keys.ApiKeys"]:
        import capo_api_gateway._operations.backplane_control_service.get_api_keys

        (
            output,
            http_response,
        ) = await capo_api_gateway._operations.backplane_control_service.get_api_keys.async_get_api_keys(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetApiKeys")
    )
    input_: capo_api_gateway.types.get_api_keys_request.GetApiKeysRequest = {}
    if position is not None:
        input_["position"] = position
    if limit is not None:
        input_["limit"] = limit
    if name_query is not None:
        input_["name_query"] = name_query
    if customer_id is not None:
        input_["customer_id"] = customer_id
    if include_values is not None:
        input_["include_values"] = include_values

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

get_api_keys async ¶

get_api_keys `async` ¶