ACMPCA / Client / get_policy

get_policy#

ACMPCA.Client.get_policy(**kwargs)#

Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException .

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

  • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

  • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

  • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.

  • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

See also: AWS API Documentation

Request Syntax

response = client.get_policy(
    ResourceArn='string'
)
Parameters:

ResourceArn (string) –

[REQUIRED]

The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA’s ARN by calling the ListCertificateAuthorities action.

Return type:

dict

Returns:

Response Syntax

{
    'Policy': 'string'
}

Response Structure

  • (dict) –

    • Policy (string) –

      The policy attached to the private CA as a JSON document.

Exceptions

  • ACMPCA.Client.exceptions.InvalidArnException

  • ACMPCA.Client.exceptions.InvalidStateException

  • ACMPCA.Client.exceptions.RequestFailedException

  • ACMPCA.Client.exceptions.ResourceNotFoundException