Skip to content

get_rule async

get_rule(
    rule_identifier: RuleIdentifier,
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
) -> GetRuleOutput

Retrieves the details of the specified rule.

Parameters:

  • rule_identifier (RuleIdentifier) –

    The identifier of the rule. This is the rule's Amazon Resource Name (ARN).

Raises:

  • AccessDeniedException –

    You do not have sufficient permissions to perform this action.

  • InternalServerException –

    The request processing failed because of an internal error in the service. This is a retryable error.

  • ResourceNotFoundException –

    The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.

  • ThrottlingException –

    The request was denied because of request throttling. Reduce your request rate and try again.

  • ValidationException –

    The request failed validation. For details, see the reason and fieldList members of the response.

  • UnknownServiceError –

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

Examples:

Get a rule Retrieves the current published version of a rule by its base ARN.

>>> await client.get_rule(rule_identifier='arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123')
Get a specific version of a rule
Retrieves a specific immutable version (snapshot) of a rule using a version-qualified ARN. The response has isSnapshot set to true. Omitting the version qualifier returns the current published rule instead.
>>> await client.get_rule(rule_identifier='arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123:3')
Source code in docs_src/capo_network_security_manager/_services/async_network_security_manager.py
async def get_rule(
    self,
    rule_identifier: "capo_network_security_manager.types.rule_identifier.RuleIdentifier",
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
) -> "capo_network_security_manager.types.get_rule_output.GetRuleOutput":
    """<p>Retrieves the details of the specified rule.</p>

    Args:
        rule_identifier: <p>The identifier of the rule. This is the rule's Amazon Resource Name (ARN).</p>

    Raises:
        capo_network_security_manager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_network_security_manager.errors.internal_server_exception.InternalServerException: <p>The request processing failed because of an internal error in the service. This is a retryable error.</p>
        capo_network_security_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.</p>
        capo_network_security_manager.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Reduce your request rate and try again.</p>
        capo_network_security_manager.errors.validation_exception.ValidationException: <p>The request failed validation. For details, see the <code>reason</code> and <code>fieldList</code> members of the response.</p>
        capo_network_security_manager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get a rule
        Retrieves the current published version of a rule by its base ARN.

        >>> await client.get_rule(rule_identifier='arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123')
        Get a specific version of a rule
        Retrieves a specific immutable version (snapshot) of a rule using a version-qualified ARN. The response has isSnapshot set to true. Omitting the version qualifier returns the current published rule instead.

        >>> await client.get_rule(rule_identifier='arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123:3')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_network_security_manager.types.get_rule_input.GetRuleInput]",
    ) -> AsyncOperationResponse[
        "capo_network_security_manager.types.get_rule_output.GetRuleOutput"
    ]:
        import capo_network_security_manager._operations.piccolo_customer_api_service.get_rule

        (
            output,
            http_response,
        ) = await capo_network_security_manager._operations.piccolo_customer_api_service.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_network_security_manager.types.get_rule_input.GetRuleInput = {
        "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