Skip to content

list_gateway_rules async

list_gateway_rules(
    gateway_identifier: GatewayIdentifier,
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
    max_results: Optional[GatewayRuleMaxResults] = None,
    next_token: Optional[GatewayRuleNextToken] = None,
) -> ListGatewayRulesResponse

Lists all rules for a gateway.

Parameters:

  • gateway_identifier (GatewayIdentifier) –

    The identifier of the gateway to list rules for.

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

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

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

    The pagination token from a previous request.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/async_bedrock_agent_core_control.py
async def list_gateway_rules(
    self,
    gateway_identifier: "capo_bedrock_agentcore_control.types.gateway_identifier.GatewayIdentifier",
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
    max_results: Optional[
        "capo_bedrock_agentcore_control.types.gateway_rule_max_results.GatewayRuleMaxResults"
    ] = None,
    next_token: Optional[
        "capo_bedrock_agentcore_control.types.gateway_rule_next_token.GatewayRuleNextToken"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.list_gateway_rules_response.ListGatewayRulesResponse":
    """<p>Lists all rules for a gateway.</p>

    Args:
        gateway_identifier: <p>The identifier of the gateway to list rules for.</p>
        max_results: <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
        next_token: <p>The pagination token from a previous request.</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.list_gateway_rules_request.ListGatewayRulesRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agentcore_control.types.list_gateway_rules_response.ListGatewayRulesResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.list_gateway_rules

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

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

        return capo_bedrock_agentcore_control.types.list_gateway_rules_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListGatewayRules", redact_output=_redact_output),
    )
    input_: capo_bedrock_agentcore_control.types.list_gateway_rules_request.ListGatewayRulesRequest = {
        "gateway_identifier": gateway_identifier
    }
    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