Skip to content

describe_rules_packages

describe_rules_packages(
    rules_package_arns: BatchDescribeArnList,
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
    locale: Optional[Locale] = None,
) -> DescribeRulesPackagesResponse

Describes the rules packages that are specified by the ARNs of the rules packages.

Parameters:

  • rules_package_arns (BatchDescribeArnList) –

    The ARN that specifies the rules package that you want to describe.

  • locale (Optional[Locale], default: None ) –

    The locale that you want to translate a rules package description into.

Raises:

Examples:

Describe rules packages Describes the rules packages that are specified by the ARNs of the rules packages.

>>> client.describe_rules_packages(rules_package_arns=['arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ'])
Source code in docs_src/capo_inspector/_services/inspector.py
def describe_rules_packages(
    self,
    rules_package_arns: "capo_inspector.types.batch_describe_arn_list.BatchDescribeArnList",
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
    locale: Optional["capo_inspector.types.locale.Locale"] = None,
) -> "capo_inspector.types.describe_rules_packages_response.DescribeRulesPackagesResponse":
    """<p>Describes the rules packages that are specified by the ARNs of the rules packages.</p>

    Args:
        rules_package_arns: <p>The ARN that specifies the rules package that you want to describe.</p>
        locale: <p>The locale that you want to translate a rules package description into.</p>

    Raises:
        capo_inspector.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_inspector.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_inspector.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Describe rules packages
        Describes the rules packages that are specified by the ARNs of the rules packages.

        >>> client.describe_rules_packages(rules_package_arns=['arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ'])
    """

    def _handler(
        req: "OperationRequest[capo_inspector.types.describe_rules_packages_request.DescribeRulesPackagesRequest]",
    ) -> OperationResponse[
        "capo_inspector.types.describe_rules_packages_response.DescribeRulesPackagesResponse"
    ]:
        import capo_inspector._operations.inspector_service.describe_rules_packages

        output, http_response = (
            capo_inspector._operations.inspector_service.describe_rules_packages.describe_rules_packages(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRulesPackages")
    )
    input_: capo_inspector.types.describe_rules_packages_request.DescribeRulesPackagesRequest = {
        "rules_package_arns": rules_package_arns
    }
    if locale is not None:
        input_["locale"] = locale

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