ACMPCA ****** Client ====== class ACMPCA.Client A low-level client representing AWS Certificate Manager Private Certificate Authority (ACM-PCA) This is the *Amazon Web Services Private Certificate Authority API Reference*. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization. The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs. Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console. import boto3 client = boto3.client('acm-pca') These are the available methods: * can_paginate * close * create_certificate_authority * create_certificate_authority_audit_report * create_permission * delete_certificate_authority * delete_permission * delete_policy * describe_certificate_authority * describe_certificate_authority_audit_report * get_certificate * get_certificate_authority_certificate * get_certificate_authority_csr * get_paginator * get_policy * get_waiter * import_certificate_authority_certificate * issue_certificate * list_certificate_authorities * list_permissions * list_tags * put_policy * restore_certificate_authority * revoke_certificate * tag_certificate_authority * untag_certificate_authority * update_certificate_authority Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCertificateAuthorities * ListPermissions * ListTags Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * AuditReportCreated * CertificateAuthorityCSRCreated * CertificateIssued ACMPCA / Waiter / CertificateAuthorityCSRCreated CertificateAuthorityCSRCreated ****************************** class ACMPCA.Waiter.CertificateAuthorityCSRCreated waiter = client.get_waiter('certificate_authority_csr_created') wait(**kwargs) Polls "ACMPCA.Client.get_certificate_authority_csr()" every 3 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( CertificateAuthorityArn='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 3 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None ACMPCA / Waiter / AuditReportCreated AuditReportCreated ****************** class ACMPCA.Waiter.AuditReportCreated waiter = client.get_waiter('audit_report_created') wait(**kwargs) Polls "ACMPCA.Client.describe_certificate_authority_audit_report()" every 3 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( CertificateAuthorityArn='string', AuditReportId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the private CA. This must be of the form: >>``<>``<<. * **AuditReportId** (*string*) -- **[REQUIRED]** The report ID returned by calling the CreateCertificateAuthorityAuditReport action. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 3 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None ACMPCA / Waiter / CertificateIssued CertificateIssued ***************** class ACMPCA.Waiter.CertificateIssued waiter = client.get_waiter('certificate_issued') wait(**kwargs) Polls "ACMPCA.Client.get_certificate()" every 1 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( CertificateAuthorityArn='string', CertificateArn='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: >>``<>``<<. * **CertificateArn** (*string*) -- **[REQUIRED]** The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: "arn:aws:acm-pca:region:account:certificate-authority/1234 5678-1234-1234-1234-123456789012/certificate/2865351539829 81100925020015808220737245" * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 1 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None ACMPCA / Paginator / ListCertificateAuthorities ListCertificateAuthorities ************************** class ACMPCA.Paginator.ListCertificateAuthorities paginator = client.get_paginator('list_certificate_authorities') paginate(**kwargs) Creates an iterator that will paginate through responses from "ACMPCA.Client.list_certificate_authorities()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ResourceOwner='SELF'|'OTHER_ACCOUNTS', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ResourceOwner** (*string*) -- Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CertificateAuthorities': [ { 'Arn': 'string', 'OwnerAccount': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastStateChangeAt': datetime(2015, 1, 1), 'Type': 'ROOT'|'SUBORDINATE', 'Serial': 'string', 'Status': 'CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED', 'NotBefore': datetime(2015, 1, 1), 'NotAfter': datetime(2015, 1, 1), 'FailureReason': 'REQUEST_TIMED_OUT'|'UNSUPPORTED_ALGORITHM'|'OTHER', 'CertificateAuthorityConfiguration': { 'KeyAlgorithm': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1'|'SM2', 'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA'|'SM3WITHSM2', 'Subject': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'CsrExtensions': { 'KeyUsage': { 'DigitalSignature': True|False, 'NonRepudiation': True|False, 'KeyEncipherment': True|False, 'DataEncipherment': True|False, 'KeyAgreement': True|False, 'KeyCertSign': True|False, 'CRLSign': True|False, 'EncipherOnly': True|False, 'DecipherOnly': True|False }, 'SubjectInformationAccess': [ { 'AccessMethod': { 'CustomObjectIdentifier': 'string', 'AccessMethodType': 'CA_REPOSITORY'|'RESOURCE_PKI_MANIFEST'|'RESOURCE_PKI_NOTIFY' }, 'AccessLocation': { 'OtherName': { 'TypeId': 'string', 'Value': 'string' }, 'Rfc822Name': 'string', 'DnsName': 'string', 'DirectoryName': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'EdiPartyName': { 'PartyName': 'string', 'NameAssigner': 'string' }, 'UniformResourceIdentifier': 'string', 'IpAddress': 'string', 'RegisteredId': 'string' } }, ] } }, 'RevocationConfiguration': { 'CrlConfiguration': { 'Enabled': True|False, 'ExpirationInDays': 123, 'CustomCname': 'string', 'S3BucketName': 'string', 'S3ObjectAcl': 'PUBLIC_READ'|'BUCKET_OWNER_FULL_CONTROL', 'CrlDistributionPointExtensionConfiguration': { 'OmitExtension': True|False }, 'CrlType': 'COMPLETE'|'PARTITIONED', 'CustomPath': 'string' }, 'OcspConfiguration': { 'Enabled': True|False, 'OcspCustomCname': 'string' } }, 'RestorableUntil': datetime(2015, 1, 1), 'KeyStorageSecurityStandard': 'FIPS_140_2_LEVEL_2_OR_HIGHER'|'FIPS_140_2_LEVEL_3_OR_HIGHER'|'CCPC_LEVEL_1_OR_HIGHER', 'UsageMode': 'GENERAL_PURPOSE'|'SHORT_LIVED_CERTIFICATE' }, ] } **Response Structure** * *(dict) --* * **CertificateAuthorities** *(list) --* Summary information about each certificate authority you have created. * *(dict) --* Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate **Subject** field owns or controls the public key contained in the **Subject Public Key Info** field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM). * **Arn** *(string) --* Amazon Resource Name (ARN) for your private certificate authority (CA). The format is >>``<<12345678-1234-1234-1234-123456789012 >>``<<. * **OwnerAccount** *(string) --* The Amazon Web Services account ID that owns the certificate authority. * **CreatedAt** *(datetime) --* Date and time at which your private CA was created. * **LastStateChangeAt** *(datetime) --* Date and time at which your private CA was last updated. * **Type** *(string) --* Type of your private CA. * **Serial** *(string) --* Serial number of your private CA. * **Status** *(string) --* Status of your private CA. * **NotBefore** *(datetime) --* Date and time before which your private CA certificate is not valid. * **NotAfter** *(datetime) --* Date and time after which your private CA certificate is not valid. * **FailureReason** *(string) --* Reason the request to create your private CA failed. * **CertificateAuthorityConfiguration** *(dict) --* Your private CA configuration. * **KeyAlgorithm** *(string) --* Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA. * **SigningAlgorithm** *(string) --* Name of the algorithm your private CA uses to sign certificate requests. This parameter should not be confused with the "SigningAlgorithm" parameter used to sign certificates when they are issued. * **Subject** *(dict) --* Structure that contains X.500 distinguished name information for your private CA. * **Country** *(string) --* Two-digit code that specifies the country in which the certificate subject located. * **Organization** *(string) --* Legal name of the organization with which the certificate subject is affiliated. * **OrganizationalUnit** *(string) --* A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. * **DistinguishedNameQualifier** *(string) --* Disambiguating information for the certificate subject. * **State** *(string) --* State in which the subject of the certificate is located. * **CommonName** *(string) --* For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject. * **SerialNumber** *(string) --* The certificate serial number. * **Locality** *(string) --* The locality (such as a city or town) in which the certificate subject is located. * **Title** *(string) --* A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject. * **Surname** *(string) --* Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first. * **GivenName** *(string) --* First name. * **Initials** *(string) --* Concatenation that typically contains the first letter of the **GivenName**, the first letter of the middle name if one exists, and the first letter of the **Surname**. * **Pseudonym** *(string) --* Typically a shortened version of a longer **GivenName**. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. * **GenerationQualifier** *(string) --* Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third. * **CustomAttributes** *(list) --* Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID). Note: Custom attributes cannot be used in combination with standard attributes. * *(dict) --* Defines the X.500 relative distinguished name (RDN). * **ObjectIdentifier** *(string) --* Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). * **Value** *(string) --* Specifies the attribute value of relative distinguished name (RDN). * **CsrExtensions** *(dict) --* Specifies information to be added to the extension section of the certificate signing request (CSR). * **KeyUsage** *(dict) --* Indicates the purpose of the certificate and of the key contained in the certificate. * **DigitalSignature** *(boolean) --* Key can be used for digital signing. * **NonRepudiation** *(boolean) --* Key can be used for non-repudiation. * **KeyEncipherment** *(boolean) --* Key can be used to encipher data. * **DataEncipherment** *(boolean) --* Key can be used to decipher data. * **KeyAgreement** *(boolean) --* Key can be used in a key-agreement protocol. * **KeyCertSign** *(boolean) --* Key can be used to sign certificates. * **CRLSign** *(boolean) --* Key can be used to sign CRLs. * **EncipherOnly** *(boolean) --* Key can be used only to encipher data. * **DecipherOnly** *(boolean) --* Key can be used only to decipher data. * **SubjectInformationAccess** *(list) --* For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280. * *(dict) --* Provides access information used by the "authorityInfoAccess" and "subjectInfoAccess" extensions described in RFC 5280. * **AccessMethod** *(dict) --* The type and format of "AccessDescription" information. * **CustomObjectIdentifier** *(string) --* An object identifier (OID) specifying the "AccessMethod". The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID). * **AccessMethodType** *(string) --* Specifies the "AccessMethod". * **AccessLocation** *(dict) --* The location of "AccessDescription" information. * **OtherName** *(dict) --* Represents "GeneralName" using an "OtherName" object. * **TypeId** *(string) --* Specifies an OID. * **Value** *(string) --* Specifies an OID value. * **Rfc822Name** *(string) --* Represents "GeneralName" as an RFC 822 email address. * **DnsName** *(string) --* Represents "GeneralName" as a DNS name. * **DirectoryName** *(dict) --* Contains information about the certificate subject. The "Subject" field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The >>``<>``</ /.crl". * **OcspConfiguration** *(dict) --* Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status. * **Enabled** *(boolean) --* Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status. * **OcspCustomCname** *(string) --* By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". For more information, see Customizing Online Certificate Status Protocol (OCSP) in the *Amazon Web Services Private Certificate Authority User Guide*. * **RestorableUntil** *(datetime) --* The period during which a deleted CA can be restored. For more information, see the "PermanentDeletionTimeInDays" parameter of the DeleteCertificateAuthorityRequest action. * **KeyStorageSecurityStandard** *(string) --* Defines a cryptographic key management compliance standard for handling and protecting CA keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Note: Starting January 26, 2023, Amazon Web Services Private CA protects all CA private keys in non- China regions using hardware security modules (HSMs) that comply with FIPS PUB 140-2 Level 3.For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys. * **UsageMode** *(string) --* Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days. The default value is GENERAL_PURPOSE. ACMPCA / Paginator / ListTags ListTags ******** class ACMPCA.Paginator.ListTags paginator = client.get_paginator('list_tags') paginate(**kwargs) Creates an iterator that will paginate through responses from "ACMPCA.Client.list_tags()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CertificateAuthorityArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* The tags associated with your private CA. * *(dict) --* Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action. * **Key** *(string) --* Key (name) of the tag. * **Value** *(string) --* Value of the tag. ACMPCA / Paginator / ListPermissions ListPermissions *************** class ACMPCA.Paginator.ListPermissions paginator = client.get_paginator('list_permissions') paginate(**kwargs) Creates an iterator that will paginate through responses from "ACMPCA.Client.list_permissions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CertificateAuthorityArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" You can get a private CA's ARN by running the ListCertificateAuthorities action. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Permissions': [ { 'CertificateAuthorityArn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'Principal': 'string', 'SourceAccount': 'string', 'Actions': [ 'IssueCertificate'|'GetCertificate'|'ListPermissions', ], 'Policy': 'string' }, ] } **Response Structure** * *(dict) --* * **Permissions** *(list) --* Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation. * *(dict) --* Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions ( "IssueCertificate", "GetCertificate", and "ListPermissions"). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action. * **CertificateAuthorityArn** *(string) --* The Amazon Resource Number (ARN) of the private CA from which the permission was issued. * **CreatedAt** *(datetime) --* The time at which the permission was created. * **Principal** *(string) --* The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is "acm.amazonaws.com". * **SourceAccount** *(string) --* The ID of the account that assigned the permission. * **Actions** *(list) --* The private CA actions that can be performed by the designated Amazon Web Services service. * *(string) --* * **Policy** *(string) --* The name of the policy that is associated with the permission. ACMPCA / Client / put_policy put_policy ********** ACMPCA.Client.put_policy(**kwargs) Attaches a resource-based policy to a private CA. A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access. The policy can be displayed with GetPolicy 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.put_policy( ResourceArn='string', Policy='string' ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action. * **Policy** (*string*) -- **[REQUIRED]** The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the "PutPolicy" action returns an "InvalidPolicyException". For information about IAM policy and statement structure, see Overview of JSON Policies. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.LockoutPreventedException" * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" * "ACMPCA.Client.exceptions.ConcurrentModificationException" * "ACMPCA.Client.exceptions.InvalidPolicyException" ACMPCA / Client / get_paginator get_paginator ************* ACMPCA.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. ACMPCA / Client / can_paginate can_paginate ************ ACMPCA.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. ACMPCA / Client / create_certificate_authority create_certificate_authority **************************** ACMPCA.Client.create_certificate_authority(**kwargs) Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA. Note: Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3. Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs. See also: AWS API Documentation **Request Syntax** response = client.create_certificate_authority( CertificateAuthorityConfiguration={ 'KeyAlgorithm': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1'|'SM2', 'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA'|'SM3WITHSM2', 'Subject': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'CsrExtensions': { 'KeyUsage': { 'DigitalSignature': True|False, 'NonRepudiation': True|False, 'KeyEncipherment': True|False, 'DataEncipherment': True|False, 'KeyAgreement': True|False, 'KeyCertSign': True|False, 'CRLSign': True|False, 'EncipherOnly': True|False, 'DecipherOnly': True|False }, 'SubjectInformationAccess': [ { 'AccessMethod': { 'CustomObjectIdentifier': 'string', 'AccessMethodType': 'CA_REPOSITORY'|'RESOURCE_PKI_MANIFEST'|'RESOURCE_PKI_NOTIFY' }, 'AccessLocation': { 'OtherName': { 'TypeId': 'string', 'Value': 'string' }, 'Rfc822Name': 'string', 'DnsName': 'string', 'DirectoryName': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'EdiPartyName': { 'PartyName': 'string', 'NameAssigner': 'string' }, 'UniformResourceIdentifier': 'string', 'IpAddress': 'string', 'RegisteredId': 'string' } }, ] } }, RevocationConfiguration={ 'CrlConfiguration': { 'Enabled': True|False, 'ExpirationInDays': 123, 'CustomCname': 'string', 'S3BucketName': 'string', 'S3ObjectAcl': 'PUBLIC_READ'|'BUCKET_OWNER_FULL_CONTROL', 'CrlDistributionPointExtensionConfiguration': { 'OmitExtension': True|False }, 'CrlType': 'COMPLETE'|'PARTITIONED', 'CustomPath': 'string' }, 'OcspConfiguration': { 'Enabled': True|False, 'OcspCustomCname': 'string' } }, CertificateAuthorityType='ROOT'|'SUBORDINATE', IdempotencyToken='string', KeyStorageSecurityStandard='FIPS_140_2_LEVEL_2_OR_HIGHER'|'FIPS_140_2_LEVEL_3_OR_HIGHER'|'CCPC_LEVEL_1_OR_HIGHER', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], UsageMode='GENERAL_PURPOSE'|'SHORT_LIVED_CERTIFICATE' ) Parameters: * **CertificateAuthorityConfiguration** (*dict*) -- **[REQUIRED]** Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information. * **KeyAlgorithm** *(string) --* **[REQUIRED]** Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA. * **SigningAlgorithm** *(string) --* **[REQUIRED]** Name of the algorithm your private CA uses to sign certificate requests. This parameter should not be confused with the "SigningAlgorithm" parameter used to sign certificates when they are issued. * **Subject** *(dict) --* **[REQUIRED]** Structure that contains X.500 distinguished name information for your private CA. * **Country** *(string) --* Two-digit code that specifies the country in which the certificate subject located. * **Organization** *(string) --* Legal name of the organization with which the certificate subject is affiliated. * **OrganizationalUnit** *(string) --* A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. * **DistinguishedNameQualifier** *(string) --* Disambiguating information for the certificate subject. * **State** *(string) --* State in which the subject of the certificate is located. * **CommonName** *(string) --* For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject. * **SerialNumber** *(string) --* The certificate serial number. * **Locality** *(string) --* The locality (such as a city or town) in which the certificate subject is located. * **Title** *(string) --* A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject. * **Surname** *(string) --* Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first. * **GivenName** *(string) --* First name. * **Initials** *(string) --* Concatenation that typically contains the first letter of the **GivenName**, the first letter of the middle name if one exists, and the first letter of the **Surname**. * **Pseudonym** *(string) --* Typically a shortened version of a longer **GivenName**. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. * **GenerationQualifier** *(string) --* Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third. * **CustomAttributes** *(list) --* Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID). Note: Custom attributes cannot be used in combination with standard attributes. * *(dict) --* Defines the X.500 relative distinguished name (RDN). * **ObjectIdentifier** *(string) --* **[REQUIRED]** Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). * **Value** *(string) --* **[REQUIRED]** Specifies the attribute value of relative distinguished name (RDN). * **CsrExtensions** *(dict) --* Specifies information to be added to the extension section of the certificate signing request (CSR). * **KeyUsage** *(dict) --* Indicates the purpose of the certificate and of the key contained in the certificate. * **DigitalSignature** *(boolean) --* Key can be used for digital signing. * **NonRepudiation** *(boolean) --* Key can be used for non-repudiation. * **KeyEncipherment** *(boolean) --* Key can be used to encipher data. * **DataEncipherment** *(boolean) --* Key can be used to decipher data. * **KeyAgreement** *(boolean) --* Key can be used in a key-agreement protocol. * **KeyCertSign** *(boolean) --* Key can be used to sign certificates. * **CRLSign** *(boolean) --* Key can be used to sign CRLs. * **EncipherOnly** *(boolean) --* Key can be used only to encipher data. * **DecipherOnly** *(boolean) --* Key can be used only to decipher data. * **SubjectInformationAccess** *(list) --* For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280. * *(dict) --* Provides access information used by the "authorityInfoAccess" and "subjectInfoAccess" extensions described in RFC 5280. * **AccessMethod** *(dict) --* **[REQUIRED]** The type and format of "AccessDescription" information. * **CustomObjectIdentifier** *(string) --* An object identifier (OID) specifying the "AccessMethod". The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID). * **AccessMethodType** *(string) --* Specifies the "AccessMethod". * **AccessLocation** *(dict) --* **[REQUIRED]** The location of "AccessDescription" information. * **OtherName** *(dict) --* Represents "GeneralName" using an "OtherName" object. * **TypeId** *(string) --* **[REQUIRED]** Specifies an OID. * **Value** *(string) --* **[REQUIRED]** Specifies an OID value. * **Rfc822Name** *(string) --* Represents "GeneralName" as an RFC 822 email address. * **DnsName** *(string) --* Represents "GeneralName" as a DNS name. * **DirectoryName** *(dict) --* Contains information about the certificate subject. The "Subject" field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The >>``<>``</ /.crl". * **OcspConfiguration** *(dict) --* Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status. * **Enabled** *(boolean) --* **[REQUIRED]** Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status. * **OcspCustomCname** *(string) --* By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". For more information, see Customizing Online Certificate Status Protocol (OCSP) in the *Amazon Web Services Private Certificate Authority User Guide*. * **CertificateAuthorityType** (*string*) -- **[REQUIRED]** The type of the certificate authority. * **IdempotencyToken** (*string*) -- Custom string that can be used to distinguish between calls to the **CreateCertificateAuthority** action. Idempotency tokens for **CreateCertificateAuthority** time out after five minutes. Therefore, if you call **CreateCertificateAuthority** multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities. * **KeyStorageSecurityStandard** (*string*) -- Specifies a cryptographic key management compliance standard for handling and protecting CA keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Note: Some Amazon Web Services Regions don't support the default value. When you create a CA in these Regions, you must use "CCPC_LEVEL_1_OR_HIGHER" for the "KeyStorageSecurityStandard" parameter. If you don't, the operation returns an "InvalidArgsException" with this message: "A certificate authority cannot be created in this region with the specified security standard."For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys. * **Tags** (*list*) -- Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags. * *(dict) --* Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action. * **Key** *(string) --* **[REQUIRED]** Key (name) of the tag. * **Value** *(string) --* Value of the tag. * **UsageMode** (*string*) -- Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days. The default value is GENERAL_PURPOSE. Return type: dict Returns: **Response Syntax** { 'CertificateAuthorityArn': 'string' } **Response Structure** * *(dict) --* * **CertificateAuthorityArn** *(string) --* If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: >>``<>``<<. **Exceptions** * "ACMPCA.Client.exceptions.LimitExceededException" * "ACMPCA.Client.exceptions.InvalidArgsException" * "ACMPCA.Client.exceptions.InvalidTagException" * "ACMPCA.Client.exceptions.InvalidPolicyException" ACMPCA / Client / list_tags list_tags ********* ACMPCA.Client.list_tags(**kwargs) Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags. See also: AWS API Documentation **Request Syntax** response = client.list_tags( MaxResults=123, NextToken='string', CertificateAuthorityArn='string' ) Parameters: * **MaxResults** (*integer*) -- Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the **NextToken** element is sent in the response. Use this **NextToken** value in a subsequent request to retrieve additional items. * **NextToken** (*string*) -- Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of **NextToken** from the response you just received. * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* When the list is truncated, this value is present and should be used for the **NextToken** parameter in a subsequent pagination request. * **Tags** *(list) --* The tags associated with your private CA. * *(dict) --* Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action. * **Key** *(string) --* Key (name) of the tag. * **Value** *(string) --* Value of the tag. **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" ACMPCA / Client / tag_certificate_authority tag_certificate_authority ************************* ACMPCA.Client.tag_certificate_authority(**kwargs) Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA. Note: To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline IAM policy with the "CreateCertificateAuthority" action and explicitly allow tagging. For more information, see Attaching tags to a CA at the time of creation. See also: AWS API Documentation **Request Syntax** response = client.tag_certificate_authority( CertificateAuthorityArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" * **Tags** (*list*) -- **[REQUIRED]** List of tags to be associated with the CA. * *(dict) --* Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action. * **Key** *(string) --* **[REQUIRED]** Key (name) of the tag. * **Value** *(string) --* Value of the tag. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.InvalidTagException" * "ACMPCA.Client.exceptions.TooManyTagsException" ACMPCA / Client / delete_permission delete_permission ***************** ACMPCA.Client.delete_permission(**kwargs) Revokes permissions on a private CA granted 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. If you revoke these permissions, ACM will no longer renew the affected certificates automatically. Permissions can be granted with the CreatePermission action and listed with the ListPermissions 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.delete_permission( CertificateAuthorityArn='string', Principal='string', SourceAccount='string' ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form: >>``<>``<<. * **Principal** (*string*) -- **[REQUIRED]** The Amazon Web Services service or identity that will have its CA permissions revoked. At this time, the only valid service principal is "acm.amazonaws.com" * **SourceAccount** (*string*) -- The Amazon Web Services account that calls this action. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" ACMPCA / Client / list_certificate_authorities list_certificate_authorities **************************** ACMPCA.Client.list_certificate_authorities(**kwargs) Lists the private certificate authorities that you created by using the CreateCertificateAuthority action. See also: AWS API Documentation **Request Syntax** response = client.list_certificate_authorities( MaxResults=123, NextToken='string', ResourceOwner='SELF'|'OTHER_ACCOUNTS' ) Parameters: * **MaxResults** (*integer*) -- Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the "NextToken" element is sent in the response. Use this "NextToken" value in a subsequent request to retrieve additional items. Although the maximum value is 1000, the action only returns a maximum of 100 items. * **NextToken** (*string*) -- Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the "NextToken" parameter from the response you just received. * **ResourceOwner** (*string*) -- Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'CertificateAuthorities': [ { 'Arn': 'string', 'OwnerAccount': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastStateChangeAt': datetime(2015, 1, 1), 'Type': 'ROOT'|'SUBORDINATE', 'Serial': 'string', 'Status': 'CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED', 'NotBefore': datetime(2015, 1, 1), 'NotAfter': datetime(2015, 1, 1), 'FailureReason': 'REQUEST_TIMED_OUT'|'UNSUPPORTED_ALGORITHM'|'OTHER', 'CertificateAuthorityConfiguration': { 'KeyAlgorithm': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1'|'SM2', 'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA'|'SM3WITHSM2', 'Subject': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'CsrExtensions': { 'KeyUsage': { 'DigitalSignature': True|False, 'NonRepudiation': True|False, 'KeyEncipherment': True|False, 'DataEncipherment': True|False, 'KeyAgreement': True|False, 'KeyCertSign': True|False, 'CRLSign': True|False, 'EncipherOnly': True|False, 'DecipherOnly': True|False }, 'SubjectInformationAccess': [ { 'AccessMethod': { 'CustomObjectIdentifier': 'string', 'AccessMethodType': 'CA_REPOSITORY'|'RESOURCE_PKI_MANIFEST'|'RESOURCE_PKI_NOTIFY' }, 'AccessLocation': { 'OtherName': { 'TypeId': 'string', 'Value': 'string' }, 'Rfc822Name': 'string', 'DnsName': 'string', 'DirectoryName': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'EdiPartyName': { 'PartyName': 'string', 'NameAssigner': 'string' }, 'UniformResourceIdentifier': 'string', 'IpAddress': 'string', 'RegisteredId': 'string' } }, ] } }, 'RevocationConfiguration': { 'CrlConfiguration': { 'Enabled': True|False, 'ExpirationInDays': 123, 'CustomCname': 'string', 'S3BucketName': 'string', 'S3ObjectAcl': 'PUBLIC_READ'|'BUCKET_OWNER_FULL_CONTROL', 'CrlDistributionPointExtensionConfiguration': { 'OmitExtension': True|False }, 'CrlType': 'COMPLETE'|'PARTITIONED', 'CustomPath': 'string' }, 'OcspConfiguration': { 'Enabled': True|False, 'OcspCustomCname': 'string' } }, 'RestorableUntil': datetime(2015, 1, 1), 'KeyStorageSecurityStandard': 'FIPS_140_2_LEVEL_2_OR_HIGHER'|'FIPS_140_2_LEVEL_3_OR_HIGHER'|'CCPC_LEVEL_1_OR_HIGHER', 'UsageMode': 'GENERAL_PURPOSE'|'SHORT_LIVED_CERTIFICATE' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* When the list is truncated, this value is present and should be used for the "NextToken" parameter in a subsequent pagination request. * **CertificateAuthorities** *(list) --* Summary information about each certificate authority you have created. * *(dict) --* Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate **Subject** field owns or controls the public key contained in the **Subject Public Key Info** field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on- premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM). * **Arn** *(string) --* Amazon Resource Name (ARN) for your private certificate authority (CA). The format is >>``<<12345678-1234-1234-1234-123456789012 >>``<<. * **OwnerAccount** *(string) --* The Amazon Web Services account ID that owns the certificate authority. * **CreatedAt** *(datetime) --* Date and time at which your private CA was created. * **LastStateChangeAt** *(datetime) --* Date and time at which your private CA was last updated. * **Type** *(string) --* Type of your private CA. * **Serial** *(string) --* Serial number of your private CA. * **Status** *(string) --* Status of your private CA. * **NotBefore** *(datetime) --* Date and time before which your private CA certificate is not valid. * **NotAfter** *(datetime) --* Date and time after which your private CA certificate is not valid. * **FailureReason** *(string) --* Reason the request to create your private CA failed. * **CertificateAuthorityConfiguration** *(dict) --* Your private CA configuration. * **KeyAlgorithm** *(string) --* Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA. * **SigningAlgorithm** *(string) --* Name of the algorithm your private CA uses to sign certificate requests. This parameter should not be confused with the "SigningAlgorithm" parameter used to sign certificates when they are issued. * **Subject** *(dict) --* Structure that contains X.500 distinguished name information for your private CA. * **Country** *(string) --* Two-digit code that specifies the country in which the certificate subject located. * **Organization** *(string) --* Legal name of the organization with which the certificate subject is affiliated. * **OrganizationalUnit** *(string) --* A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. * **DistinguishedNameQualifier** *(string) --* Disambiguating information for the certificate subject. * **State** *(string) --* State in which the subject of the certificate is located. * **CommonName** *(string) --* For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject. * **SerialNumber** *(string) --* The certificate serial number. * **Locality** *(string) --* The locality (such as a city or town) in which the certificate subject is located. * **Title** *(string) --* A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject. * **Surname** *(string) --* Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first. * **GivenName** *(string) --* First name. * **Initials** *(string) --* Concatenation that typically contains the first letter of the **GivenName**, the first letter of the middle name if one exists, and the first letter of the **Surname**. * **Pseudonym** *(string) --* Typically a shortened version of a longer **GivenName**. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. * **GenerationQualifier** *(string) --* Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third. * **CustomAttributes** *(list) --* Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID). Note: Custom attributes cannot be used in combination with standard attributes. * *(dict) --* Defines the X.500 relative distinguished name (RDN). * **ObjectIdentifier** *(string) --* Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). * **Value** *(string) --* Specifies the attribute value of relative distinguished name (RDN). * **CsrExtensions** *(dict) --* Specifies information to be added to the extension section of the certificate signing request (CSR). * **KeyUsage** *(dict) --* Indicates the purpose of the certificate and of the key contained in the certificate. * **DigitalSignature** *(boolean) --* Key can be used for digital signing. * **NonRepudiation** *(boolean) --* Key can be used for non-repudiation. * **KeyEncipherment** *(boolean) --* Key can be used to encipher data. * **DataEncipherment** *(boolean) --* Key can be used to decipher data. * **KeyAgreement** *(boolean) --* Key can be used in a key-agreement protocol. * **KeyCertSign** *(boolean) --* Key can be used to sign certificates. * **CRLSign** *(boolean) --* Key can be used to sign CRLs. * **EncipherOnly** *(boolean) --* Key can be used only to encipher data. * **DecipherOnly** *(boolean) --* Key can be used only to decipher data. * **SubjectInformationAccess** *(list) --* For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280. * *(dict) --* Provides access information used by the "authorityInfoAccess" and "subjectInfoAccess" extensions described in RFC 5280. * **AccessMethod** *(dict) --* The type and format of "AccessDescription" information. * **CustomObjectIdentifier** *(string) --* An object identifier (OID) specifying the "AccessMethod". The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID). * **AccessMethodType** *(string) --* Specifies the "AccessMethod". * **AccessLocation** *(dict) --* The location of "AccessDescription" information. * **OtherName** *(dict) --* Represents "GeneralName" using an "OtherName" object. * **TypeId** *(string) --* Specifies an OID. * **Value** *(string) --* Specifies an OID value. * **Rfc822Name** *(string) --* Represents "GeneralName" as an RFC 822 email address. * **DnsName** *(string) --* Represents "GeneralName" as a DNS name. * **DirectoryName** *(dict) --* Contains information about the certificate subject. The "Subject" field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The >>``<>``</ /.crl". * **OcspConfiguration** *(dict) --* Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status. * **Enabled** *(boolean) --* Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status. * **OcspCustomCname** *(string) --* By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". For more information, see Customizing Online Certificate Status Protocol (OCSP) in the *Amazon Web Services Private Certificate Authority User Guide*. * **RestorableUntil** *(datetime) --* The period during which a deleted CA can be restored. For more information, see the "PermanentDeletionTimeInDays" parameter of the DeleteCertificateAuthorityRequest action. * **KeyStorageSecurityStandard** *(string) --* Defines a cryptographic key management compliance standard for handling and protecting CA keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Note: Starting January 26, 2023, Amazon Web Services Private CA protects all CA private keys in non-China regions using hardware security modules (HSMs) that comply with FIPS PUB 140-2 Level 3.For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys. * **UsageMode** *(string) --* Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days. The default value is GENERAL_PURPOSE. **Exceptions** * "ACMPCA.Client.exceptions.InvalidNextTokenException" ACMPCA / Client / delete_certificate_authority delete_certificate_authority **************************** ACMPCA.Client.delete_certificate_authority(**kwargs) Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action. Note: Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy. Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the **CertificateAuthorityStatus** parameter to "DISABLED". Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is "CREATING"). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that is, the status of the CA is "PENDING_CERTIFICATE"). When you successfully call DeleteCertificateAuthority, the CA's status changes to "DELETED". However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the "PermanentDeletionTimeInDays" parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the "DELETED" state. To restore an eligible CA, call the RestoreCertificateAuthority action. Warning: A private CA can be deleted if it is in the "PENDING_CERTIFICATE", "CREATING", "EXPIRED", "DISABLED", or "FAILED" state. To delete a CA in the "ACTIVE" state, you must first disable it, or else the delete request results in an exception. If you are deleting a private CA in the "PENDING_CERTIFICATE" or "DISABLED" state, you can set the length of its restoration period to 7-30 days. The default is 30. During this time, the status is set to "DELETED" and the CA can be restored. A private CA deleted in the "CREATING" or "FAILED" state has no assigned restoration period and cannot be restored. See also: AWS API Documentation **Request Syntax** response = client.delete_certificate_authority( CertificateAuthorityArn='string', PermanentDeletionTimeInDays=123 ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form: >>``<>``<<. * **PermanentDeletionTimeInDays** (*integer*) -- The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.ConcurrentModificationException" ACMPCA / Client / import_certificate_authority_certificate import_certificate_authority_certificate **************************************** ACMPCA.Client.import_certificate_authority_certificate(**kwargs) Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place: * In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate. * Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR). * Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA. * Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. Amazon Web Services Private CA supports three scenarios for installing a CA certificate: * Installing a certificate for a root CA hosted by Amazon Web Services Private CA. * Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA. * Installing a subordinate CA certificate whose parent authority is externally hosted. The following additional requirements apply when you import a CA certificate. * Only a self-signed certificate can be imported as a root CA. * A self-signed certificate cannot be imported as a subordinate CA. * Your certificate chain must not include the private CA certificate that you are importing. * Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. * The chain must be PEM-encoded. * The maximum allowed size of a certificate is 32 KB. * The maximum allowed size of a certificate chain is 2 MB. *Enforcement of Critical Constraints* Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain. * Authority key identifier * Basic constraints (*must* be marked critical) * Certificate policies * Extended key usage * Inhibit anyPolicy * Issuer alternative name * Key usage * Name constraints * Policy mappings * Subject alternative name * Subject directory attributes * Subject key identifier * Subject information access Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain. * Authority information access * CRL distribution points * Freshest CRL * Policy constraints Amazon Web Services Private Certificate Authority will also reject any other extension marked as critical not contained on the preceding list of allowed extensions. See also: AWS API Documentation **Request Syntax** response = client.import_certificate_authority_certificate( CertificateAuthorityArn='string', Certificate=b'bytes', CertificateChain=b'bytes' ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" * **Certificate** (*bytes*) -- **[REQUIRED]** The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control. * **CertificateChain** (*bytes*) -- A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding. This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.CertificateMismatchException" * "ACMPCA.Client.exceptions.MalformedCertificateException" * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidRequestException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" * "ACMPCA.Client.exceptions.ConcurrentModificationException" * "ACMPCA.Client.exceptions.RequestInProgressException" ACMPCA / Client / get_certificate_authority_certificate get_certificate_authority_certificate ************************************* ACMPCA.Client.get_certificate_authority_certificate(**kwargs) Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it. See also: AWS API Documentation **Request Syntax** response = client.get_certificate_authority_certificate( CertificateAuthorityArn='string' ) Parameters: **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of your private CA. This is of the form: >>``<>``<<. Return type: dict Returns: **Response Syntax** { 'Certificate': 'string', 'CertificateChain': 'string' } **Response Structure** * *(dict) --* * **Certificate** *(string) --* Base64-encoded certificate authority (CA) certificate. * **CertificateChain** *(string) --* Base64-encoded certificate chain that includes any intermediate certificates and chains up to root certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. If this is a root CA, the value will be null. **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" ACMPCA / Client / update_certificate_authority update_certificate_authority **************************** ACMPCA.Client.update_certificate_authority(**kwargs) Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the "ACTIVE" or "DISABLED" state before you can update it. You can disable a private CA that is in the "ACTIVE" state or make a CA that is in the "DISABLED" state active again. Note: Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3. See also: AWS API Documentation **Request Syntax** response = client.update_certificate_authority( CertificateAuthorityArn='string', RevocationConfiguration={ 'CrlConfiguration': { 'Enabled': True|False, 'ExpirationInDays': 123, 'CustomCname': 'string', 'S3BucketName': 'string', 'S3ObjectAcl': 'PUBLIC_READ'|'BUCKET_OWNER_FULL_CONTROL', 'CrlDistributionPointExtensionConfiguration': { 'OmitExtension': True|False }, 'CrlType': 'COMPLETE'|'PARTITIONED', 'CustomPath': 'string' }, 'OcspConfiguration': { 'Enabled': True|False, 'OcspCustomCname': 'string' } }, Status='CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED' ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" * **RevocationConfiguration** (*dict*) -- Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types. The following requirements apply to revocation configurations. * A configuration disabling CRLs or OCSP must contain only the "Enabled=False" parameter, and will fail if other parameters such as "CustomCname" or "ExpirationInDays" are included. * In a CRL configuration, the "S3BucketName" parameter must conform to Amazon S3 bucket naming rules. * A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME. * In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://". Warning: If you update the "S3BucketName" of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future. * **CrlConfiguration** *(dict) --* Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes. * **Enabled** *(boolean) --* **[REQUIRED]** Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action. * **ExpirationInDays** *(integer) --* Validity period of the CRL in days. * **CustomCname** *(string) --* Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public. Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". * **S3BucketName** *(string) --* Name of the S3 bucket that contains the CRL. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket. Note: The "S3BucketName" parameter must conform to the S3 bucket naming rules. * **S3ObjectAcl** *(string) --* Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access. If no value is specified, the default is "PUBLIC_READ". *Note:* This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as "BUCKET_OWNER_FULL_CONTROL", and not doing so results in an error. If you have disabled BPA in S3, then you can specify either "BUCKET_OWNER_FULL_CONTROL" or "PUBLIC_READ" as the value. For more information, see Blocking public access to the S3 bucket. * **CrlDistributionPointExtensionConfiguration** *(dict) --* Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL. * **OmitExtension** *(boolean) --* **[REQUIRED]** Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to "true", then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough. Note: Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance LedgerThis configuration cannot be enabled with a custom CNAME set. * **CrlType** *(string) --* Specifies whether to create a complete or partitioned CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see Amazon Web Services Private CA quotas. * "COMPLETE" - The default setting. Amazon Web Services Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that Amazon Web Services Private CA issues is bound to a specific CRL through its CRL distribution point (CDP) extension, defined in RFC 5280. * "PARTITIONED" - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue. Warning: When using partitioned CRLs, you must validate that the CRL's associated issuing distribution point (IDP) URI matches the certificate's CDP URI to ensure the right CRL has been fetched. Amazon Web Services Private CA marks the IDP extension as critical, which your client must be able to process. * **CustomPath** *(string) --* Designates a custom file path in S3 for CRL(s). For example, "http:/// /.crl". * **OcspConfiguration** *(dict) --* Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status. * **Enabled** *(boolean) --* **[REQUIRED]** Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status. * **OcspCustomCname** *(string) --* By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". For more information, see Customizing Online Certificate Status Protocol (OCSP) in the *Amazon Web Services Private Certificate Authority User Guide*. * **Status** (*string*) -- Status of your private CA. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArgsException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.ConcurrentModificationException" * "ACMPCA.Client.exceptions.InvalidPolicyException" ACMPCA / Client / get_waiter get_waiter ********** ACMPCA.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" ACMPCA / Client / delete_policy delete_policy ************* ACMPCA.Client.delete_policy(**kwargs) Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful. If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included. The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. The current policy can be shown with GetPolicy and updated with PutPolicy. **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.delete_policy( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form "arn:aws:acm-pca:region:account:certificate- authority/01234567-89ab-cdef-0123-0123456789ab". Returns: None **Exceptions** * "ACMPCA.Client.exceptions.LockoutPreventedException" * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" * "ACMPCA.Client.exceptions.ConcurrentModificationException" ACMPCA / Client / issue_certificate issue_certificate ***************** ACMPCA.Client.issue_certificate(**kwargs) Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN. Note: You cannot use the ACM **ListCertificateAuthorities** action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA. See also: AWS API Documentation **Request Syntax** response = client.issue_certificate( ApiPassthrough={ 'Extensions': { 'CertificatePolicies': [ { 'CertPolicyId': 'string', 'PolicyQualifiers': [ { 'PolicyQualifierId': 'CPS', 'Qualifier': { 'CpsUri': 'string' } }, ] }, ], 'ExtendedKeyUsage': [ { 'ExtendedKeyUsageType': 'SERVER_AUTH'|'CLIENT_AUTH'|'CODE_SIGNING'|'EMAIL_PROTECTION'|'TIME_STAMPING'|'OCSP_SIGNING'|'SMART_CARD_LOGIN'|'DOCUMENT_SIGNING'|'CERTIFICATE_TRANSPARENCY', 'ExtendedKeyUsageObjectIdentifier': 'string' }, ], 'KeyUsage': { 'DigitalSignature': True|False, 'NonRepudiation': True|False, 'KeyEncipherment': True|False, 'DataEncipherment': True|False, 'KeyAgreement': True|False, 'KeyCertSign': True|False, 'CRLSign': True|False, 'EncipherOnly': True|False, 'DecipherOnly': True|False }, 'SubjectAlternativeNames': [ { 'OtherName': { 'TypeId': 'string', 'Value': 'string' }, 'Rfc822Name': 'string', 'DnsName': 'string', 'DirectoryName': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'EdiPartyName': { 'PartyName': 'string', 'NameAssigner': 'string' }, 'UniformResourceIdentifier': 'string', 'IpAddress': 'string', 'RegisteredId': 'string' }, ], 'CustomExtensions': [ { 'ObjectIdentifier': 'string', 'Value': 'string', 'Critical': True|False }, ] }, 'Subject': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] } }, CertificateAuthorityArn='string', Csr=b'bytes', SigningAlgorithm='SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA'|'SM3WITHSM2', TemplateArn='string', Validity={ 'Value': 123, 'Type': 'END_DATE'|'ABSOLUTE'|'DAYS'|'MONTHS'|'YEARS' }, ValidityNotBefore={ 'Value': 123, 'Type': 'END_DATE'|'ABSOLUTE'|'DAYS'|'MONTHS'|'YEARS' }, IdempotencyToken='string' ) Parameters: * **ApiPassthrough** (*dict*) -- Specifies X.509 certificate information to be included in the issued certificate. An "APIPassthrough" or "APICSRPassthrough" template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates. If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used. * **Extensions** *(dict) --* Specifies X.509 extension information for a certificate. * **CertificatePolicies** *(list) --* Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID). In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate. * *(dict) --* Defines the X.509 "CertificatePolicies" extension. * **CertPolicyId** *(string) --* **[REQUIRED]** Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID). * **PolicyQualifiers** *(list) --* Modifies the given "CertPolicyId" with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier. * *(dict) --* Modifies the "CertPolicyId" of a "PolicyInformation" object with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier. * **PolicyQualifierId** *(string) --* **[REQUIRED]** Identifies the qualifier modifying a "CertPolicyId". * **Qualifier** *(dict) --* **[REQUIRED]** Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier in this field. * **CpsUri** *(string) --* **[REQUIRED]** Contains a pointer to a certification practice statement (CPS) published by the CA. * **ExtendedKeyUsage** *(list) --* Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the "KeyUsage" extension. * *(dict) --* Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the "KeyUsage" extension. * **ExtendedKeyUsageType** *(string) --* Specifies a standard "ExtendedKeyUsage" as defined as in RFC 5280. * **ExtendedKeyUsageObjectIdentifier** *(string) --* Specifies a custom "ExtendedKeyUsage" with an object identifier (OID). * **KeyUsage** *(dict) --* Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false. * **DigitalSignature** *(boolean) --* Key can be used for digital signing. * **NonRepudiation** *(boolean) --* Key can be used for non-repudiation. * **KeyEncipherment** *(boolean) --* Key can be used to encipher data. * **DataEncipherment** *(boolean) --* Key can be used to decipher data. * **KeyAgreement** *(boolean) --* Key can be used in a key-agreement protocol. * **KeyCertSign** *(boolean) --* Key can be used to sign certificates. * **CRLSign** *(boolean) --* Key can be used to sign CRLs. * **EncipherOnly** *(boolean) --* Key can be used only to encipher data. * **DecipherOnly** *(boolean) --* Key can be used only to decipher data. * **SubjectAlternativeNames** *(list) --* The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate. * *(dict) --* Describes an ASN.1 X.400 "GeneralName" as defined in RFC 5280. Only one of the following naming options should be provided. Providing more than one option results in an "InvalidArgsException" error. * **OtherName** *(dict) --* Represents "GeneralName" using an "OtherName" object. * **TypeId** *(string) --* **[REQUIRED]** Specifies an OID. * **Value** *(string) --* **[REQUIRED]** Specifies an OID value. * **Rfc822Name** *(string) --* Represents "GeneralName" as an RFC 822 email address. * **DnsName** *(string) --* Represents "GeneralName" as a DNS name. * **DirectoryName** *(dict) --* Contains information about the certificate subject. The "Subject" field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The >>``<>``<>``<>``<>``<>``<<. Return type: dict Returns: **Response Syntax** { 'CertificateAuthority': { 'Arn': 'string', 'OwnerAccount': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastStateChangeAt': datetime(2015, 1, 1), 'Type': 'ROOT'|'SUBORDINATE', 'Serial': 'string', 'Status': 'CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED', 'NotBefore': datetime(2015, 1, 1), 'NotAfter': datetime(2015, 1, 1), 'FailureReason': 'REQUEST_TIMED_OUT'|'UNSUPPORTED_ALGORITHM'|'OTHER', 'CertificateAuthorityConfiguration': { 'KeyAlgorithm': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1'|'SM2', 'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA'|'SM3WITHSM2', 'Subject': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'CsrExtensions': { 'KeyUsage': { 'DigitalSignature': True|False, 'NonRepudiation': True|False, 'KeyEncipherment': True|False, 'DataEncipherment': True|False, 'KeyAgreement': True|False, 'KeyCertSign': True|False, 'CRLSign': True|False, 'EncipherOnly': True|False, 'DecipherOnly': True|False }, 'SubjectInformationAccess': [ { 'AccessMethod': { 'CustomObjectIdentifier': 'string', 'AccessMethodType': 'CA_REPOSITORY'|'RESOURCE_PKI_MANIFEST'|'RESOURCE_PKI_NOTIFY' }, 'AccessLocation': { 'OtherName': { 'TypeId': 'string', 'Value': 'string' }, 'Rfc822Name': 'string', 'DnsName': 'string', 'DirectoryName': { 'Country': 'string', 'Organization': 'string', 'OrganizationalUnit': 'string', 'DistinguishedNameQualifier': 'string', 'State': 'string', 'CommonName': 'string', 'SerialNumber': 'string', 'Locality': 'string', 'Title': 'string', 'Surname': 'string', 'GivenName': 'string', 'Initials': 'string', 'Pseudonym': 'string', 'GenerationQualifier': 'string', 'CustomAttributes': [ { 'ObjectIdentifier': 'string', 'Value': 'string' }, ] }, 'EdiPartyName': { 'PartyName': 'string', 'NameAssigner': 'string' }, 'UniformResourceIdentifier': 'string', 'IpAddress': 'string', 'RegisteredId': 'string' } }, ] } }, 'RevocationConfiguration': { 'CrlConfiguration': { 'Enabled': True|False, 'ExpirationInDays': 123, 'CustomCname': 'string', 'S3BucketName': 'string', 'S3ObjectAcl': 'PUBLIC_READ'|'BUCKET_OWNER_FULL_CONTROL', 'CrlDistributionPointExtensionConfiguration': { 'OmitExtension': True|False }, 'CrlType': 'COMPLETE'|'PARTITIONED', 'CustomPath': 'string' }, 'OcspConfiguration': { 'Enabled': True|False, 'OcspCustomCname': 'string' } }, 'RestorableUntil': datetime(2015, 1, 1), 'KeyStorageSecurityStandard': 'FIPS_140_2_LEVEL_2_OR_HIGHER'|'FIPS_140_2_LEVEL_3_OR_HIGHER'|'CCPC_LEVEL_1_OR_HIGHER', 'UsageMode': 'GENERAL_PURPOSE'|'SHORT_LIVED_CERTIFICATE' } } **Response Structure** * *(dict) --* * **CertificateAuthority** *(dict) --* A CertificateAuthority structure that contains information about your private CA. * **Arn** *(string) --* Amazon Resource Name (ARN) for your private certificate authority (CA). The format is >>``<<12345678-1234-1234-1234-123456789012 >>``<<. * **OwnerAccount** *(string) --* The Amazon Web Services account ID that owns the certificate authority. * **CreatedAt** *(datetime) --* Date and time at which your private CA was created. * **LastStateChangeAt** *(datetime) --* Date and time at which your private CA was last updated. * **Type** *(string) --* Type of your private CA. * **Serial** *(string) --* Serial number of your private CA. * **Status** *(string) --* Status of your private CA. * **NotBefore** *(datetime) --* Date and time before which your private CA certificate is not valid. * **NotAfter** *(datetime) --* Date and time after which your private CA certificate is not valid. * **FailureReason** *(string) --* Reason the request to create your private CA failed. * **CertificateAuthorityConfiguration** *(dict) --* Your private CA configuration. * **KeyAlgorithm** *(string) --* Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA. * **SigningAlgorithm** *(string) --* Name of the algorithm your private CA uses to sign certificate requests. This parameter should not be confused with the "SigningAlgorithm" parameter used to sign certificates when they are issued. * **Subject** *(dict) --* Structure that contains X.500 distinguished name information for your private CA. * **Country** *(string) --* Two-digit code that specifies the country in which the certificate subject located. * **Organization** *(string) --* Legal name of the organization with which the certificate subject is affiliated. * **OrganizationalUnit** *(string) --* A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. * **DistinguishedNameQualifier** *(string) --* Disambiguating information for the certificate subject. * **State** *(string) --* State in which the subject of the certificate is located. * **CommonName** *(string) --* For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject. * **SerialNumber** *(string) --* The certificate serial number. * **Locality** *(string) --* The locality (such as a city or town) in which the certificate subject is located. * **Title** *(string) --* A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject. * **Surname** *(string) --* Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first. * **GivenName** *(string) --* First name. * **Initials** *(string) --* Concatenation that typically contains the first letter of the **GivenName**, the first letter of the middle name if one exists, and the first letter of the **Surname**. * **Pseudonym** *(string) --* Typically a shortened version of a longer **GivenName**. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. * **GenerationQualifier** *(string) --* Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third. * **CustomAttributes** *(list) --* Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID). Note: Custom attributes cannot be used in combination with standard attributes. * *(dict) --* Defines the X.500 relative distinguished name (RDN). * **ObjectIdentifier** *(string) --* Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). * **Value** *(string) --* Specifies the attribute value of relative distinguished name (RDN). * **CsrExtensions** *(dict) --* Specifies information to be added to the extension section of the certificate signing request (CSR). * **KeyUsage** *(dict) --* Indicates the purpose of the certificate and of the key contained in the certificate. * **DigitalSignature** *(boolean) --* Key can be used for digital signing. * **NonRepudiation** *(boolean) --* Key can be used for non-repudiation. * **KeyEncipherment** *(boolean) --* Key can be used to encipher data. * **DataEncipherment** *(boolean) --* Key can be used to decipher data. * **KeyAgreement** *(boolean) --* Key can be used in a key-agreement protocol. * **KeyCertSign** *(boolean) --* Key can be used to sign certificates. * **CRLSign** *(boolean) --* Key can be used to sign CRLs. * **EncipherOnly** *(boolean) --* Key can be used only to encipher data. * **DecipherOnly** *(boolean) --* Key can be used only to decipher data. * **SubjectInformationAccess** *(list) --* For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280. * *(dict) --* Provides access information used by the "authorityInfoAccess" and "subjectInfoAccess" extensions described in RFC 5280. * **AccessMethod** *(dict) --* The type and format of "AccessDescription" information. * **CustomObjectIdentifier** *(string) --* An object identifier (OID) specifying the "AccessMethod". The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID). * **AccessMethodType** *(string) --* Specifies the "AccessMethod". * **AccessLocation** *(dict) --* The location of "AccessDescription" information. * **OtherName** *(dict) --* Represents "GeneralName" using an "OtherName" object. * **TypeId** *(string) --* Specifies an OID. * **Value** *(string) --* Specifies an OID value. * **Rfc822Name** *(string) --* Represents "GeneralName" as an RFC 822 email address. * **DnsName** *(string) --* Represents "GeneralName" as a DNS name. * **DirectoryName** *(dict) --* Contains information about the certificate subject. The "Subject" field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The >>``<>``</ /.crl". * **OcspConfiguration** *(dict) --* Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status. * **Enabled** *(boolean) --* Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status. * **OcspCustomCname** *(string) --* By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". For more information, see Customizing Online Certificate Status Protocol (OCSP) in the *Amazon Web Services Private Certificate Authority User Guide*. * **RestorableUntil** *(datetime) --* The period during which a deleted CA can be restored. For more information, see the "PermanentDeletionTimeInDays" parameter of the DeleteCertificateAuthorityRequest action. * **KeyStorageSecurityStandard** *(string) --* Defines a cryptographic key management compliance standard for handling and protecting CA keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Note: Starting January 26, 2023, Amazon Web Services Private CA protects all CA private keys in non-China regions using hardware security modules (HSMs) that comply with FIPS PUB 140-2 Level 3.For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys. * **UsageMode** *(string) --* Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days. The default value is GENERAL_PURPOSE. **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" ACMPCA / Client / get_certificate get_certificate *************** ACMPCA.Client.get_certificate(**kwargs) Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the **GetCertificate** action. You can retrieve the certificate if it is in the **ISSUED**, **EXPIRED**, or **REVOKED** state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA. See also: AWS API Documentation **Request Syntax** response = client.get_certificate( CertificateAuthorityArn='string', CertificateArn='string' ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: >>``<>``<<. * **CertificateArn** (*string*) -- **[REQUIRED]** The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: "arn:aws:acm-pca:region:account:certificate-authority/1234567 8-1234-1234-1234-123456789012/certificate/2865351539829811009 25020015808220737245" Return type: dict Returns: **Response Syntax** { 'Certificate': 'string', 'CertificateChain': 'string' } **Response Structure** * *(dict) --* * **Certificate** *(string) --* The base64 PEM-encoded certificate specified by the "CertificateArn" parameter. * **CertificateChain** *(string) --* The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate. **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" * "ACMPCA.Client.exceptions.RequestInProgressException" 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: >>``<>``<<. * **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.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" 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.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" ACMPCA / Client / revoke_certificate revoke_certificate ****************** ACMPCA.Client.revoke_certificate(**kwargs) Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics "CRLGenerated" and "MisconfiguredCRLBucket". For more information, see Supported CloudWatch Metrics. Note: Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3. Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport. Note: You cannot revoke a root CA self-signed certificate. See also: AWS API Documentation **Request Syntax** response = client.revoke_certificate( CertificateAuthorityArn='string', CertificateSerial='string', RevocationReason='UNSPECIFIED'|'KEY_COMPROMISE'|'CERTIFICATE_AUTHORITY_COMPROMISE'|'AFFILIATION_CHANGED'|'SUPERSEDED'|'CESSATION_OF_OPERATION'|'PRIVILEGE_WITHDRAWN'|'A_A_COMPROMISE' ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" * **CertificateSerial** (*string*) -- **[REQUIRED]** Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The **GetCertificate** action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. "openssl x509 -in file_path -text -noout" You can also copy the serial number from the console or use the DescribeCertificate action in the *Certificate Manager API Reference*. * **RevocationReason** (*string*) -- **[REQUIRED]** Specifies why you revoked the certificate. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.RequestAlreadyProcessedException" * "ACMPCA.Client.exceptions.LimitExceededException" * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidRequestException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" * "ACMPCA.Client.exceptions.ConcurrentModificationException" * "ACMPCA.Client.exceptions.RequestInProgressException" ACMPCA / Client / list_permissions list_permissions **************** ACMPCA.Client.list_permissions(**kwargs) List all permissions on a private CA, if any, granted 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. Permissions can be granted with the CreatePermission action and revoked 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.list_permissions( MaxResults=123, NextToken='string', CertificateAuthorityArn='string' ) Parameters: * **MaxResults** (*integer*) -- When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the **NextToken** element is sent in the response. Use this **NextToken** value in a subsequent request to retrieve additional items. * **NextToken** (*string*) -- When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of **NextToken** from the response you just received. * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: "arn:aws:acm- pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" You can get a private CA's ARN by running the ListCertificateAuthorities action. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Permissions': [ { 'CertificateAuthorityArn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'Principal': 'string', 'SourceAccount': 'string', 'Actions': [ 'IssueCertificate'|'GetCertificate'|'ListPermissions', ], 'Policy': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* When the list is truncated, this value is present and should be used for the **NextToken** parameter in a subsequent pagination request. * **Permissions** *(list) --* Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation. * *(dict) --* Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions ( "IssueCertificate", "GetCertificate", and "ListPermissions"). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action. * **CertificateAuthorityArn** *(string) --* The Amazon Resource Number (ARN) of the private CA from which the permission was issued. * **CreatedAt** *(datetime) --* The time at which the permission was created. * **Principal** *(string) --* The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is "acm.amazonaws.com". * **SourceAccount** *(string) --* The ID of the account that assigned the permission. * **Actions** *(list) --* The private CA actions that can be performed by the designated Amazon Web Services service. * *(string) --* * **Policy** *(string) --* The name of the policy that is associated with the permission. **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" * "ACMPCA.Client.exceptions.InvalidNextTokenException" ACMPCA / Client / create_certificate_authority_audit_report create_certificate_authority_audit_report ***************************************** ACMPCA.Client.create_certificate_authority_audit_report(**kwargs) Creates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use the private key. To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see Prepare an Amazon S3 bucket for audit reports. Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports. Note: You can generate a maximum of one report every 30 minutes. See also: AWS API Documentation **Request Syntax** response = client.create_certificate_authority_audit_report( CertificateAuthorityArn='string', S3BucketName='string', AuditReportResponseFormat='JSON'|'CSV' ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the CA to be audited. This is of the form: >>``<>``<<. * **S3BucketName** (*string*) -- **[REQUIRED]** The name of the S3 bucket that will contain the audit report. * **AuditReportResponseFormat** (*string*) -- **[REQUIRED]** The format in which to create the report. This can be either **JSON** or **CSV**. Return type: dict Returns: **Response Syntax** { 'AuditReportId': 'string', 'S3Key': 'string' } **Response Structure** * *(dict) --* * **AuditReportId** *(string) --* An alphanumeric string that contains a report identifier. * **S3Key** *(string) --* The **key** that uniquely identifies the report file in your S3 bucket. **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArgsException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.RequestFailedException" * "ACMPCA.Client.exceptions.RequestInProgressException" ACMPCA / Client / describe_certificate_authority_audit_report describe_certificate_authority_audit_report ******************************************* ACMPCA.Client.describe_certificate_authority_audit_report(**kwargs) Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action. See also: AWS API Documentation **Request Syntax** response = client.describe_certificate_authority_audit_report( CertificateAuthorityArn='string', AuditReportId='string' ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the private CA. This must be of the form: >>``<>``<<. * **AuditReportId** (*string*) -- **[REQUIRED]** The report ID returned by calling the CreateCertificateAuthorityAuditReport action. Return type: dict Returns: **Response Syntax** { 'AuditReportStatus': 'CREATING'|'SUCCESS'|'FAILED', 'S3BucketName': 'string', 'S3Key': 'string', 'CreatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **AuditReportStatus** *(string) --* Specifies whether report creation is in progress, has succeeded, or has failed. * **S3BucketName** *(string) --* Name of the S3 bucket that contains the report. * **S3Key** *(string) --* S3 **key** that uniquely identifies the report file in your S3 bucket. * **CreatedAt** *(datetime) --* The date and time at which the report was created. **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArgsException" * "ACMPCA.Client.exceptions.InvalidArnException" ACMPCA / Client / untag_certificate_authority untag_certificate_authority *************************** ACMPCA.Client.untag_certificate_authority(**kwargs) Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA. See also: AWS API Documentation **Request Syntax** response = client.untag_certificate_authority( CertificateAuthorityArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **CertificateAuthorityArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: "arn:aws:acm-pca:region:account:certificate- authority/12345678-1234-1234-1234-123456789012" * **Tags** (*list*) -- **[REQUIRED]** List of tags to be removed from the CA. * *(dict) --* Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action. * **Key** *(string) --* **[REQUIRED]** Key (name) of the tag. * **Value** *(string) --* Value of the tag. Returns: None **Exceptions** * "ACMPCA.Client.exceptions.ResourceNotFoundException" * "ACMPCA.Client.exceptions.InvalidArnException" * "ACMPCA.Client.exceptions.InvalidStateException" * "ACMPCA.Client.exceptions.InvalidTagException"