ACMPCA / Client / create_permission

create_permission#

ACMPCA.Client.create_permission(**kwargs)#

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal ( acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

See also: AWS API Documentation

Request Syntax

response = client.create_permission(
    CertificateAuthorityArn='string',
    Principal='string',
    SourceAccount='string',
    Actions=[
        'IssueCertificate'|'GetCertificate'|'ListPermissions',
    ]
)
Parameters:

  • CertificateAuthorityArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

    ``arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 ``.

  • Principal (string) –

    [REQUIRED]

    The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

  • SourceAccount (string) – The ID of the calling account.

  • Actions (list) –

    [REQUIRED]

    The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

    • (string) –

Returns:

None

Exceptions

  • ACMPCA.Client.exceptions.LimitExceededException

  • ACMPCA.Client.exceptions.PermissionAlreadyExistsException

  • ACMPCA.Client.exceptions.ResourceNotFoundException

  • ACMPCA.Client.exceptions.InvalidArnException

  • ACMPCA.Client.exceptions.RequestFailedException

  • ACMPCA.Client.exceptions.InvalidStateException