get_rule `async` ¶

get_rule(
    service_identifier: ServiceIdentifier,
    listener_identifier: ListenerIdentifier,
    rule_identifier: RuleIdentifier,
    *,
    config_overrides: Optional[AsyncVPCLatticeClientConfig] = None,
) -> GetRuleResponse

Retrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Parameters:

service_identifier (ServiceIdentifier) –

The ID or ARN of the service.
listener_identifier (ListenerIdentifier) –

The ID or ARN of the listener.
rule_identifier (RuleIdentifier) –

The ID or ARN of the listener rule.

Raises:

AccessDeniedException –

The user does not have sufficient access to perform this action.
InternalServerException –

An unexpected error occurred while processing the request.
ResourceNotFoundException –

The request references a resource that does not exist.
ThrottlingException –

The limit on the number of requests per second was exceeded.
ValidationException –

The input does not satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

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

Source code in docs_src/capo_vpc_lattice/_services/async_vpc_lattice.py

async def get_rule(
    self,
    service_identifier: "capo_vpc_lattice.types.service_identifier.ServiceIdentifier",
    listener_identifier: "capo_vpc_lattice.types.listener_identifier.ListenerIdentifier",
    rule_identifier: "capo_vpc_lattice.types.rule_identifier.RuleIdentifier",
    *,
    config_overrides: Optional[AsyncVPCLatticeClientConfig] = None,
) -> "capo_vpc_lattice.types.get_rule_response.GetRuleResponse":
    """<p>Retrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see <a href="https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules">Listener rules</a> in the <i>Amazon VPC Lattice User Guide</i>.</p>

    Args:
        service_identifier: <p>The ID or ARN of the service.</p>
        listener_identifier: <p>The ID or ARN of the listener.</p>
        rule_identifier: <p>The ID or ARN of the listener rule.</p>

    Raises:
        capo_vpc_lattice.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action.</p>
        capo_vpc_lattice.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_vpc_lattice.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_vpc_lattice.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_vpc_lattice.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_vpc_lattice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_vpc_lattice.types.get_rule_request.GetRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_vpc_lattice.types.get_rule_response.GetRuleResponse"
    ]:
        import capo_vpc_lattice._operations.mercury_control_plane.get_rule

        (
            output,
            http_response,
        ) = await capo_vpc_lattice._operations.mercury_control_plane.get_rule.async_get_rule(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRule")
    )
    input_: capo_vpc_lattice.types.get_rule_request.GetRuleRequest = {
        "service_identifier": service_identifier,
        "listener_identifier": listener_identifier,
        "rule_identifier": rule_identifier,
    }

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

get_rule async ¶

get_rule `async` ¶