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: CertificateAuthorityConfigurationTypeDef, # (1)
CertificateAuthorityType: CertificateAuthorityTypeType, # (2)
RevocationConfiguration: RevocationConfigurationTypeDef = ..., # (3)
IdempotencyToken: str = ...,
KeyStorageSecurityStandard: KeyStorageSecurityStandardType = ..., # (4)
Tags: Sequence[TagTypeDef] = ..., # (5)
UsageMode: CertificateAuthorityUsageModeType = ..., # (6)
) -> CreateCertificateAuthorityResponseTypeDef: # (7)
...- See CertificateAuthorityConfigurationTypeDef
- See CertificateAuthorityTypeType
- See RevocationConfigurationTypeDef
- See KeyStorageSecurityStandardType
- See TagTypeDef
- See CertificateAuthorityUsageModeType
- See CreateCertificateAuthorityResponseTypeDef
# create_certificate_authority method usage example with argument unpacking
kwargs: CreateCertificateAuthorityRequestRequestTypeDef = { # (1)
"CertificateAuthorityConfiguration": ...,
"CertificateAuthorityType": ...,
}
parent.create_certificate_authority(**kwargs)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)
...# create_certificate_authority_audit_report method usage example with argument unpacking
kwargs: CreateCertificateAuthorityAuditReportRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"S3BucketName": ...,
"AuditReportResponseFormat": ...,
}
parent.create_certificate_authority_audit_report(**kwargs)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)
...# create_permission method usage example with argument unpacking
kwargs: CreatePermissionRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"Principal": ...,
"Actions": ...,
}
parent.create_permission(**kwargs)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)
...# delete_certificate_authority method usage example with argument unpacking
kwargs: DeleteCertificateAuthorityRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.delete_certificate_authority(**kwargs)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)
...# delete_permission method usage example with argument unpacking
kwargs: DeletePermissionRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"Principal": ...,
}
parent.delete_permission(**kwargs)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)
...# delete_policy method usage example with argument unpacking
kwargs: DeletePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.delete_policy(**kwargs)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)
...# describe_certificate_authority method usage example with argument unpacking
kwargs: DescribeCertificateAuthorityRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.describe_certificate_authority(**kwargs)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)
...# describe_certificate_authority_audit_report method usage example with argument unpacking
kwargs: DescribeCertificateAuthorityAuditReportRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"AuditReportId": ...,
}
parent.describe_certificate_authority_audit_report(**kwargs)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.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...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)
...# get_certificate method usage example with argument unpacking
kwargs: GetCertificateRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"CertificateArn": ...,
}
parent.get_certificate(**kwargs)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)
...# get_certificate_authority_certificate method usage example with argument unpacking
kwargs: GetCertificateAuthorityCertificateRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.get_certificate_authority_certificate(**kwargs)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)
...# get_certificate_authority_csr method usage example with argument unpacking
kwargs: GetCertificateAuthorityCsrRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.get_certificate_authority_csr(**kwargs)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)
...# get_policy method usage example with argument unpacking
kwargs: GetPolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_policy(**kwargs)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: Union[str, bytes, IO[Any], StreamingBody],
CertificateChain: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# import_certificate_authority_certificate method usage example with argument unpacking
kwargs: ImportCertificateAuthorityCertificateRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"Certificate": ...,
}
parent.import_certificate_authority_certificate(**kwargs)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.