Skip to content

get_gateway_rule async

get_gateway_rule(
    gateway_identifier: GatewayIdentifier,
    rule_id: GatewayRuleId,
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
) -> GetGatewayRuleResponse

Retrieves detailed information about a specific gateway rule.

Parameters:

  • gateway_identifier (GatewayIdentifier) –

    The identifier of the gateway containing the rule.

  • rule_id (GatewayRuleId) –

    The unique identifier of the rule to retrieve.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/async_bedrock_agent_core_control.py
async def get_gateway_rule(
    self,
    gateway_identifier: "capo_bedrock_agentcore_control.types.gateway_identifier.GatewayIdentifier",
    rule_id: "capo_bedrock_agentcore_control.types.gateway_rule_id.GatewayRuleId",
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
) -> "capo_bedrock_agentcore_control.types.get_gateway_rule_response.GetGatewayRuleResponse":
    """<p>Retrieves detailed information about a specific gateway rule.</p>

    Args:
        gateway_identifier: <p>The identifier of the gateway containing the rule.</p>
        rule_id: <p>The unique identifier of the rule to retrieve.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agentcore_control.types.get_gateway_rule_request.GetGatewayRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agentcore_control.types.get_gateway_rule_response.GetGatewayRuleResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.get_gateway_rule

        (
            output,
            http_response,
        ) = await capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.get_gateway_rule.async_get_gateway_rule(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_bedrock_agentcore_control.types.get_gateway_rule_response.GetGatewayRuleResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore_control.types.get_gateway_rule_response

        return capo_bedrock_agentcore_control.types.get_gateway_rule_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetGatewayRule", redact_output=_redact_output),
    )
    input_: capo_bedrock_agentcore_control.types.get_gateway_rule_request.GetGatewayRuleRequest = {
        "gateway_identifier": gateway_identifier,
        "rule_id": rule_id,
    }

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