Skip to content

describe_managed_products_by_vendor

describe_managed_products_by_vendor(
    vendor_name: VendorName,
    scope: Scope,
    *,
    config_overrides: Optional[WAFV2ClientConfig] = None,
) -> DescribeManagedProductsByVendorResponse

Provides high-level information for the managed rule groups owned by a specific vendor.

Parameters:

  • vendor_name (VendorName) –

    The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

  • scope (Scope) –

    Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

Raises:

  • WAFInternalErrorException –

    Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

  • WAFInvalidOperationException –

    The operation isn't valid.

  • WAFInvalidParameterException –

    The operation failed because WAF didn't recognize a parameter in the request. For example:

    • You specified a parameter name or value that isn't valid.

    • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

    • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

    • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

  • UnknownServiceError –

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

Source code in docs_src/capo_wafv2/_services/wafv2.py
def describe_managed_products_by_vendor(
    self,
    vendor_name: "capo_wafv2.types.vendor_name.VendorName",
    scope: "capo_wafv2.types.scope.Scope",
    *,
    config_overrides: Optional[WAFV2ClientConfig] = None,
) -> "capo_wafv2.types.describe_managed_products_by_vendor_response.DescribeManagedProductsByVendorResponse":
    """<p>Provides high-level information for the managed rule groups owned by a specific vendor. </p>

    Args:
        vendor_name: <p>The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.</p>
        scope: <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>

    Raises:
        capo_wafv2.errors.waf_internal_error_exception.WAFInternalErrorException: <p>Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request. </p>
        capo_wafv2.errors.waf_invalid_operation_exception.WAFInvalidOperationException: <p>The operation isn't valid. </p>
        capo_wafv2.errors.waf_invalid_parameter_exception.WAFInvalidParameterException: <p>The operation failed because WAF didn't recognize a parameter in the request. For example: </p> <ul> <li> <p>You specified a parameter name or value that isn't valid.</p> </li> <li> <p>Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. </p> </li> <li> <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that isn't among the types available at <a>DefaultAction</a>.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.</p> </li> </ul>
        capo_wafv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wafv2.types.describe_managed_products_by_vendor_request.DescribeManagedProductsByVendorRequest]",
    ) -> OperationResponse[
        "capo_wafv2.types.describe_managed_products_by_vendor_response.DescribeManagedProductsByVendorResponse"
    ]:
        import capo_wafv2._operations.awswaf_20190729.describe_managed_products_by_vendor

        output, http_response = (
            capo_wafv2._operations.awswaf_20190729.describe_managed_products_by_vendor.describe_managed_products_by_vendor(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeManagedProductsByVendor")
    )
    input_: capo_wafv2.types.describe_managed_products_by_vendor_request.DescribeManagedProductsByVendorRequest = {
        "vendor_name": vendor_name,
        "scope": scope,
    }

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