Skip to content

ACMPCAClient#

Index > ACMPCA > ACMPCAClient

Auto-generated documentation for ACMPCA type annotations stubs module mypy-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 mypy_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 mypy_boto3_acm_pca.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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: Union[CertificateAuthorityConfigurationTypeDef, CertificateAuthorityConfigurationExtraOutputTypeDef],  # (1)
    CertificateAuthorityType: CertificateAuthorityTypeType,  # (2)
    RevocationConfiguration: RevocationConfigurationTypeDef = ...,  # (3)
    IdempotencyToken: str = ...,
    KeyStorageSecurityStandard: KeyStorageSecurityStandardType = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    UsageMode: CertificateAuthorityUsageModeType = ...,  # (6)
) -> CreateCertificateAuthorityResponseTypeDef:  # (7)
    ...
  1. See CertificateAuthorityConfigurationTypeDef CertificateAuthorityConfigurationExtraOutputTypeDef
  2. See CertificateAuthorityTypeType
  3. See RevocationConfigurationTypeDef
  4. See KeyStorageSecurityStandardType
  5. See TagTypeDef
  6. See CertificateAuthorityUsageModeType
  7. See CreateCertificateAuthorityResponseTypeDef
# create_certificate_authority method usage example with argument unpacking

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

parent.create_certificate_authority(**kwargs)
  1. See CreateCertificateAuthorityRequestRequestTypeDef

create_certificate_authority_audit_report#

Creates an audit report that lists every time that your CA private key is used.

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: CreateCertificateAuthorityAuditReportRequestRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "S3BucketName": ...,
    "AuditReportResponseFormat": ...,
}

parent.create_certificate_authority_audit_report(**kwargs)
  1. See CreateCertificateAuthorityAuditReportRequestRequestTypeDef

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 ActionTypeType
  2. See EmptyResponseMetadataTypeDef
# create_permission method usage example with argument unpacking

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

parent.create_permission(**kwargs)
  1. See CreatePermissionRequestRequestTypeDef

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: DeleteCertificateAuthorityRequestRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.delete_certificate_authority(**kwargs)
  1. See DeleteCertificateAuthorityRequestRequestTypeDef

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: DeletePermissionRequestRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "Principal": ...,
}

parent.delete_permission(**kwargs)
  1. See DeletePermissionRequestRequestTypeDef

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: DeletePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_policy(**kwargs)
  1. See DeletePolicyRequestRequestTypeDef

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: DescribeCertificateAuthorityRequestRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
}

parent.describe_certificate_authority(**kwargs)
  1. See DescribeCertificateAuthorityRequestRequestTypeDef

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: DescribeCertificateAuthorityAuditReportRequestRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "AuditReportId": ...,
}

parent.describe_certificate_authority_audit_report(**kwargs)
  1. See DescribeCertificateAuthorityAuditReportRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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