Skip to content

list_usage_limits async

list_usage_limits(
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = None,
    resource_arn: Optional[str] = None,
    usage_type: Optional[UsageLimitUsageType] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[int] = None,
) -> ListUsageLimitsResponse

Lists all usage limits within Amazon Redshift Serverless.

Parameters:

  • resource_arn (Optional[str], default: None ) –

    The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

  • usage_type (Optional[UsageLimitUsageType], default: None ) –

    The Amazon Redshift Serverless feature whose limits you want to see.

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

    If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.

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

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

Raises:

Source code in docs_src/capo_redshift_serverless/_services/async_redshift_serverless.py
async def list_usage_limits(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = None,
    resource_arn: Optional[str] = None,
    usage_type: Optional[
        "capo_redshift_serverless.types.usage_limit_usage_type.UsageLimitUsageType"
    ] = None,
    next_token: Optional[
        "capo_redshift_serverless.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[int] = None,
) -> "capo_redshift_serverless.types.list_usage_limits_response.ListUsageLimitsResponse":
    """<p>Lists all usage limits within Amazon Redshift Serverless.</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.</p>
        usage_type: <p>The Amazon Redshift Serverless feature whose limits you want to see.</p>
        next_token: <p>If your initial <code>ListUsageLimits</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in following <code>ListUsageLimits</code> operations, which returns results in the next page. </p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 100.</p>

    Raises:
        capo_redshift_serverless.errors.conflict_exception.ConflictException: <p>The submitted action has conflicts.</p>
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.invalid_pagination_exception.InvalidPaginationException: <p>The provided pagination token is invalid.</p>
        capo_redshift_serverless.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift_serverless.types.list_usage_limits_request.ListUsageLimitsRequest]",
    ) -> AsyncOperationResponse[
        "capo_redshift_serverless.types.list_usage_limits_response.ListUsageLimitsResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.list_usage_limits

        (
            output,
            http_response,
        ) = await capo_redshift_serverless._operations.redshift_serverless.list_usage_limits.async_list_usage_limits(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListUsageLimits")
    )
    input_: capo_redshift_serverless.types.list_usage_limits_request.ListUsageLimitsRequest = {}
    if resource_arn is not None:
        input_["resource_arn"] = resource_arn
    if usage_type is not None:
        input_["usage_type"] = usage_type
    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