Skip to content

update_gateway_rate_limit

update_gateway_rate_limit(
    gateway_identifier: GatewayIdentifier,
    rate_limit_id: GatewayRateLimitId,
    entries: LimitEntries,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    description: Optional[GatewayRateLimitDescription] = None,
) -> UpdateGatewayRateLimitResponse

Updates the entries of a gateway rate limit. The dimension keys are immutable after creation.

Parameters:

  • gateway_identifier (GatewayIdentifier) –

    The unique identifier of the gateway.

  • rate_limit_id (GatewayRateLimitId) –

    The unique identifier of the rate limit to update.

  • description (Optional[GatewayRateLimitDescription], default: None ) –

    The updated human-readable description for this rate limit.

  • entries (LimitEntries) –

    The updated rule entries. The dimension keys are immutable after creation and cannot be changed.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def update_gateway_rate_limit(
    self,
    gateway_identifier: "capo_bedrock_agentcore_control.types.gateway_identifier.GatewayIdentifier",
    rate_limit_id: "capo_bedrock_agentcore_control.types.gateway_rate_limit_id.GatewayRateLimitId",
    entries: "capo_bedrock_agentcore_control.types.limit_entries.LimitEntries",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    description: Optional[
        "capo_bedrock_agentcore_control.types.gateway_rate_limit_description.GatewayRateLimitDescription"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.update_gateway_rate_limit_response.UpdateGatewayRateLimitResponse":
    """<p>Updates the entries of a gateway rate limit. The dimension keys are immutable after creation.</p>

    Args:
        gateway_identifier: <p>The unique identifier of the gateway.</p>
        rate_limit_id: <p>The unique identifier of the rate limit to update.</p>
        description: <p>The updated human-readable description for this rate limit.</p>
        entries: <p>The updated rule entries. The dimension keys are immutable after creation and cannot be changed.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.update_gateway_rate_limit_request.UpdateGatewayRateLimitRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.update_gateway_rate_limit_response.UpdateGatewayRateLimitResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_gateway_rate_limit

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_gateway_rate_limit.update_gateway_rate_limit(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGatewayRateLimit")
    )
    input_: capo_bedrock_agentcore_control.types.update_gateway_rate_limit_request.UpdateGatewayRateLimitRequest = {
        "gateway_identifier": gateway_identifier,
        "rate_limit_id": rate_limit_id,
        "entries": entries,
    }
    if description is not None:
        input_["description"] = description

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output