ACMPCAClient

Index > ACMPCA > ACMPCAClient

Auto-generated documentation for ACMPCA type annotations stubs module types-boto3-acm-pca.

ACMPCAClient

Type annotations and code completion for boto3.client("acm-pca"). boto3 documentation

# ACMPCAClient usage example

from boto3.session import Session
from types_boto3_acm_pca.client import ACMPCAClient

def get_acm-pca_client() -> ACMPCAClient:
    return Session().client("acm-pca")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("acm-pca").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("acm-pca")

try:
    do_something(client)
except (
    client.exceptions.CertificateMismatchException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.InvalidArgsException,
    client.exceptions.InvalidArnException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidPolicyException,
    client.exceptions.InvalidRequestException,
    client.exceptions.InvalidStateException,
    client.exceptions.InvalidTagException,
    client.exceptions.LimitExceededException,
    client.exceptions.LockoutPreventedException,
    client.exceptions.MalformedCSRException,
    client.exceptions.MalformedCertificateException,
    client.exceptions.PermissionAlreadyExistsException,
    client.exceptions.RequestAlreadyProcessedException,
    client.exceptions.RequestFailedException,
    client.exceptions.RequestInProgressException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TooManyTagsException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_acm_pca.client import Exceptions

def handle_error(exc: Exceptions.CertificateMismatchException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("acm-pca").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("acm-pca").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_certificate_authority

Creates a root or subordinate private certificate authority (CA).

Type annotations and code completion for boto3.client("acm-pca").create_certificate_authority method. boto3 documentation

# create_certificate_authority method definition

def create_certificate_authority(
    self,
    *,
    CertificateAuthorityConfiguration: CertificateAuthorityConfigurationUnionTypeDef,  # (1)
    CertificateAuthorityType: CertificateAuthorityTypeType,  # (2)
    RevocationConfiguration: RevocationConfigurationTypeDef = ...,  # (3)
    IdempotencyToken: str = ...,
    KeyStorageSecurityStandard: KeyStorageSecurityStandardType = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    UsageMode: CertificateAuthorityUsageModeType = ...,  # (6)
) -> CreateCertificateAuthorityResponseTypeDef:  # (7)
    ...

1. See CertificateAuthorityConfigurationUnionTypeDef
2. See CertificateAuthorityTypeType
3. See RevocationConfigurationTypeDef
4. See KeyStorageSecurityStandardType
5. See Sequence[TagTypeDef]
6. See CertificateAuthorityUsageModeType
7. See CreateCertificateAuthorityResponseTypeDef

# create_certificate_authority method usage example with argument unpacking

kwargs: CreateCertificateAuthorityRequestTypeDef = {  # (1)
    "CertificateAuthorityConfiguration": ...,
    "CertificateAuthorityType": ...,
}

parent.create_certificate_authority(**kwargs)

1. See CreateCertificateAuthorityRequestTypeDef

create_certificate_authority_audit_report

Creates an audit report that lists every time that your CA private key is used to issue a certificate.

Type annotations and code completion for boto3.client("acm-pca").create_certificate_authority_audit_report method. boto3 documentation

# create_certificate_authority_audit_report method definition

def create_certificate_authority_audit_report(
    self,
    *,
    CertificateAuthorityArn: str,
    S3BucketName: str,
    AuditReportResponseFormat: AuditReportResponseFormatType,  # (1)
) -> CreateCertificateAuthorityAuditReportResponseTypeDef:  # (2)
    ...

1. See AuditReportResponseFormatType
2. See CreateCertificateAuthorityAuditReportResponseTypeDef

# create_certificate_authority_audit_report method usage example with argument unpacking

kwargs: CreateCertificateAuthorityAuditReportRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "S3BucketName": ...,
    "AuditReportResponseFormat": ...,
}

parent.create_certificate_authority_audit_report(**kwargs)

1. See CreateCertificateAuthorityAuditReportRequestTypeDef

create_permission

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

Type annotations and code completion for boto3.client("acm-pca").create_permission method. boto3 documentation

# create_permission method definition

def create_permission(
    self,
    *,
    CertificateAuthorityArn: str,
    Principal: str,
    Actions: Sequence[ActionTypeType],  # (1)
    SourceAccount: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[ActionTypeType]
2. See EmptyResponseMetadataTypeDef

# create_permission method usage example with argument unpacking

kwargs: CreatePermissionRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "Principal": ...,
    "Actions": ...,
}

parent.create_permission(**kwargs)

1. See CreatePermissionRequestTypeDef

delete_certificate_authority

Deletes a private certificate authority (CA).

Type annotations and code completion for boto3.client("acm-pca").delete_certificate_authority method. boto3 documentation

# delete_certificate_authority method definition

def delete_certificate_authority(
    self,
    *,
    CertificateAuthorityArn: str,
    PermanentDeletionTimeInDays: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_certificate_authority method usage example with argument unpacking

kwargs: DeleteCertificateAuthorityRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.delete_certificate_authority(**kwargs)

1. See DeleteCertificateAuthorityRequestTypeDef

delete_permission

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

Type annotations and code completion for boto3.client("acm-pca").delete_permission method. boto3 documentation

# delete_permission method definition

def delete_permission(
    self,
    *,
    CertificateAuthorityArn: str,
    Principal: str,
    SourceAccount: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_permission method usage example with argument unpacking

kwargs: DeletePermissionRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "Principal": ...,
}

parent.delete_permission(**kwargs)

1. See DeletePermissionRequestTypeDef

delete_policy

Deletes the resource-based policy attached to a private CA.

Type annotations and code completion for boto3.client("acm-pca").delete_policy method. boto3 documentation

# delete_policy method definition

def delete_policy(
    self,
    *,
    ResourceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_policy method usage example with argument unpacking

kwargs: DeletePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_policy(**kwargs)

1. See DeletePolicyRequestTypeDef

describe_certificate_authority

Lists information about your private certificate authority (CA) or one that has been shared with you.

Type annotations and code completion for boto3.client("acm-pca").describe_certificate_authority method. boto3 documentation

# describe_certificate_authority method definition

def describe_certificate_authority(
    self,
    *,
    CertificateAuthorityArn: str,
) -> DescribeCertificateAuthorityResponseTypeDef:  # (1)
    ...

1. See DescribeCertificateAuthorityResponseTypeDef

# describe_certificate_authority method usage example with argument unpacking

kwargs: DescribeCertificateAuthorityRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.describe_certificate_authority(**kwargs)

1. See DescribeCertificateAuthorityRequestTypeDef

describe_certificate_authority_audit_report

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action.

Type annotations and code completion for boto3.client("acm-pca").describe_certificate_authority_audit_report method. boto3 documentation

# describe_certificate_authority_audit_report method definition

def describe_certificate_authority_audit_report(
    self,
    *,
    CertificateAuthorityArn: str,
    AuditReportId: str,
) -> DescribeCertificateAuthorityAuditReportResponseTypeDef:  # (1)
    ...

1. See DescribeCertificateAuthorityAuditReportResponseTypeDef

# describe_certificate_authority_audit_report method usage example with argument unpacking

kwargs: DescribeCertificateAuthorityAuditReportRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "AuditReportId": ...,
}

parent.describe_certificate_authority_audit_report(**kwargs)

1. See DescribeCertificateAuthorityAuditReportRequestTypeDef

get_certificate

Retrieves a certificate from your private CA or one that has been shared with you.

Type annotations and code completion for boto3.client("acm-pca").get_certificate method. boto3 documentation

# get_certificate method definition

def get_certificate(
    self,
    *,
    CertificateAuthorityArn: str,
    CertificateArn: str,
) -> GetCertificateResponseTypeDef:  # (1)
    ...

1. See GetCertificateResponseTypeDef

# get_certificate method usage example with argument unpacking

kwargs: GetCertificateRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "CertificateArn": ...,
}

parent.get_certificate(**kwargs)

1. See GetCertificateRequestTypeDef

get_certificate_authority_certificate

Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you.

Type annotations and code completion for boto3.client("acm-pca").get_certificate_authority_certificate method. boto3 documentation

# get_certificate_authority_certificate method definition

def get_certificate_authority_certificate(
    self,
    *,
    CertificateAuthorityArn: str,
) -> GetCertificateAuthorityCertificateResponseTypeDef:  # (1)
    ...

1. See GetCertificateAuthorityCertificateResponseTypeDef

# get_certificate_authority_certificate method usage example with argument unpacking

kwargs: GetCertificateAuthorityCertificateRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.get_certificate_authority_certificate(**kwargs)

1. See GetCertificateAuthorityCertificateRequestTypeDef

get_certificate_authority_csr

Retrieves the certificate signing request (CSR) for your private certificate authority (CA).

Type annotations and code completion for boto3.client("acm-pca").get_certificate_authority_csr method. boto3 documentation

# get_certificate_authority_csr method definition

def get_certificate_authority_csr(
    self,
    *,
    CertificateAuthorityArn: str,
) -> GetCertificateAuthorityCsrResponseTypeDef:  # (1)
    ...

1. See GetCertificateAuthorityCsrResponseTypeDef

# get_certificate_authority_csr method usage example with argument unpacking

kwargs: GetCertificateAuthorityCsrRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.get_certificate_authority_csr(**kwargs)

1. See GetCertificateAuthorityCsrRequestTypeDef

get_policy

Retrieves the resource-based policy attached to a private CA.

Type annotations and code completion for boto3.client("acm-pca").get_policy method. boto3 documentation

# get_policy method definition

def get_policy(
    self,
    *,
    ResourceArn: str,
) -> GetPolicyResponseTypeDef:  # (1)
    ...

1. See GetPolicyResponseTypeDef

# get_policy method usage example with argument unpacking

kwargs: GetPolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_policy(**kwargs)

1. See GetPolicyRequestTypeDef

import_certificate_authority_certificate

Imports a signed private CA certificate into Amazon Web Services Private CA.

Type annotations and code completion for boto3.client("acm-pca").import_certificate_authority_certificate method. boto3 documentation

# import_certificate_authority_certificate method definition

def import_certificate_authority_certificate(
    self,
    *,
    CertificateAuthorityArn: str,
    Certificate: BlobTypeDef,
    CertificateChain: BlobTypeDef = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# import_certificate_authority_certificate method usage example with argument unpacking

kwargs: ImportCertificateAuthorityCertificateRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "Certificate": ...,
}

parent.import_certificate_authority_certificate(**kwargs)

1. See ImportCertificateAuthorityCertificateRequestTypeDef

issue_certificate

Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate.

Type annotations and code completion for boto3.client("acm-pca").issue_certificate method. boto3 documentation

# issue_certificate method definition

def issue_certificate(
    self,
    *,
    CertificateAuthorityArn: str,
    Csr: BlobTypeDef,
    SigningAlgorithm: SigningAlgorithmType,  # (1)
    Validity: ValidityTypeDef,  # (2)
    ApiPassthrough: ApiPassthroughTypeDef = ...,  # (3)
    TemplateArn: str = ...,
    ValidityNotBefore: ValidityTypeDef = ...,  # (2)
    IdempotencyToken: str = ...,
) -> IssueCertificateResponseTypeDef:  # (5)
    ...

1. See SigningAlgorithmType
2. See ValidityTypeDef
3. See ApiPassthroughTypeDef
4. See ValidityTypeDef
5. See IssueCertificateResponseTypeDef

# issue_certificate method usage example with argument unpacking

kwargs: IssueCertificateRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "Csr": ...,
    "SigningAlgorithm": ...,
    "Validity": ...,
}

parent.issue_certificate(**kwargs)

1. See IssueCertificateRequestTypeDef

list_certificate_authorities

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

Type annotations and code completion for boto3.client("acm-pca").list_certificate_authorities method. boto3 documentation

# list_certificate_authorities method definition

def list_certificate_authorities(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    ResourceOwner: ResourceOwnerType = ...,  # (1)
) -> ListCertificateAuthoritiesResponseTypeDef:  # (2)
    ...

1. See ResourceOwnerType
2. See ListCertificateAuthoritiesResponseTypeDef

# list_certificate_authorities method usage example with argument unpacking

kwargs: ListCertificateAuthoritiesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_certificate_authorities(**kwargs)

1. See ListCertificateAuthoritiesRequestTypeDef

list_permissions

List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

Type annotations and code completion for boto3.client("acm-pca").list_permissions method. boto3 documentation

# list_permissions method definition

def list_permissions(
    self,
    *,
    CertificateAuthorityArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPermissionsResponseTypeDef:  # (1)
    ...

1. See ListPermissionsResponseTypeDef

# list_permissions method usage example with argument unpacking

kwargs: ListPermissionsRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.list_permissions(**kwargs)

1. See ListPermissionsRequestTypeDef

list_tags

Lists the tags, if any, that are associated with your private CA or one that has been shared with you.

Type annotations and code completion for boto3.client("acm-pca").list_tags method. boto3 documentation

# list_tags method definition

def list_tags(
    self,
    *,
    CertificateAuthorityArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsResponseTypeDef:  # (1)
    ...

1. See ListTagsResponseTypeDef

# list_tags method usage example with argument unpacking

kwargs: ListTagsRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.list_tags(**kwargs)

1. See ListTagsRequestTypeDef

put_policy

Attaches a resource-based policy to a private CA.

Type annotations and code completion for boto3.client("acm-pca").put_policy method. boto3 documentation

# put_policy method definition

def put_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# put_policy method usage example with argument unpacking

kwargs: PutPolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}

parent.put_policy(**kwargs)

1. See PutPolicyRequestTypeDef

restore_certificate_authority

Restores a certificate authority (CA) that is in the DELETED state.

Type annotations and code completion for boto3.client("acm-pca").restore_certificate_authority method. boto3 documentation

# restore_certificate_authority method definition

def restore_certificate_authority(
    self,
    *,
    CertificateAuthorityArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# restore_certificate_authority method usage example with argument unpacking

kwargs: RestoreCertificateAuthorityRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.restore_certificate_authority(**kwargs)

1. See RestoreCertificateAuthorityRequestTypeDef

revoke_certificate

Revokes a certificate that was issued inside Amazon Web Services Private CA.

Type annotations and code completion for boto3.client("acm-pca").revoke_certificate method. boto3 documentation

# revoke_certificate method definition

def revoke_certificate(
    self,
    *,
    CertificateAuthorityArn: str,
    CertificateSerial: str,
    RevocationReason: RevocationReasonType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See RevocationReasonType
2. See EmptyResponseMetadataTypeDef

# revoke_certificate method usage example with argument unpacking

kwargs: RevokeCertificateRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "CertificateSerial": ...,
    "RevocationReason": ...,
}

parent.revoke_certificate(**kwargs)

1. See RevokeCertificateRequestTypeDef

tag_certificate_authority

Adds one or more tags to your private CA.

Type annotations and code completion for boto3.client("acm-pca").tag_certificate_authority method. boto3 documentation

# tag_certificate_authority method definition

def tag_certificate_authority(
    self,
    *,
    CertificateAuthorityArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# tag_certificate_authority method usage example with argument unpacking

kwargs: TagCertificateAuthorityRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "Tags": ...,
}

parent.tag_certificate_authority(**kwargs)

1. See TagCertificateAuthorityRequestTypeDef

untag_certificate_authority

Remove one or more tags from your private CA.

Type annotations and code completion for boto3.client("acm-pca").untag_certificate_authority method. boto3 documentation

# untag_certificate_authority method definition

def untag_certificate_authority(
    self,
    *,
    CertificateAuthorityArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# untag_certificate_authority method usage example with argument unpacking

kwargs: UntagCertificateAuthorityRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "Tags": ...,
}

parent.untag_certificate_authority(**kwargs)

1. See UntagCertificateAuthorityRequestTypeDef

update_certificate_authority

Updates the status or configuration of a private certificate authority (CA).

Type annotations and code completion for boto3.client("acm-pca").update_certificate_authority method. boto3 documentation

# update_certificate_authority method definition

def update_certificate_authority(
    self,
    *,
    CertificateAuthorityArn: str,
    RevocationConfiguration: RevocationConfigurationTypeDef = ...,  # (1)
    Status: CertificateAuthorityStatusType = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See RevocationConfigurationTypeDef
2. See CertificateAuthorityStatusType
3. See EmptyResponseMetadataTypeDef

# update_certificate_authority method usage example with argument unpacking

kwargs: UpdateCertificateAuthorityRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.update_certificate_authority(**kwargs)

1. See UpdateCertificateAuthorityRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("acm-pca").get_paginator method with overloads.

• client.get_paginator("list_certificate_authorities") -> ListCertificateAuthoritiesPaginator
• client.get_paginator("list_permissions") -> ListPermissionsPaginator
• client.get_paginator("list_tags") -> ListTagsPaginator

get_waiter

Type annotations and code completion for boto3.client("acm-pca").get_waiter method with overloads.

• client.get_waiter("audit_report_created") -> AuditReportCreatedWaiter
• client.get_waiter("certificate_authority_csr_created") -> CertificateAuthorityCSRCreatedWaiter
• client.get_waiter("certificate_issued") -> CertificateIssuedWaiter