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
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.
client = boto3.client("acm-pca")
try:
do_something(client)
except (
client.CertificateMismatchException,
client.ClientError,
client.ConcurrentModificationException,
client.InvalidArgsException,
client.InvalidArnException,
client.InvalidNextTokenException,
client.InvalidPolicyException,
client.InvalidRequestException,
client.InvalidStateException,
client.InvalidTagException,
client.LimitExceededException,
client.LockoutPreventedException,
client.MalformedCSRException,
client.MalformedCertificateException,
client.PermissionAlreadyExistsException,
client.RequestAlreadyProcessedException,
client.RequestFailedException,
client.RequestInProgressException,
client.ResourceNotFoundException,
client.TooManyTagsException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("acm-pca").close
method.
boto3 documentation
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
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
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
def create_certificate_authority_audit_report(
self,
*,
CertificateAuthorityArn: str,
S3BucketName: str,
AuditReportResponseFormat: AuditReportResponseFormatType, # (1)
) -> CreateCertificateAuthorityAuditReportResponseTypeDef: # (2)
...
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
def create_permission(
self,
*,
CertificateAuthorityArn: str,
Principal: str,
Actions: Sequence[ActionTypeType], # (1)
SourceAccount: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
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
def delete_certificate_authority(
self,
*,
CertificateAuthorityArn: str,
PermanentDeletionTimeInDays: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def delete_permission(
self,
*,
CertificateAuthorityArn: str,
Principal: str,
SourceAccount: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def delete_policy(
self,
*,
ResourceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def describe_certificate_authority(
self,
*,
CertificateAuthorityArn: str,
) -> DescribeCertificateAuthorityResponseTypeDef: # (1)
...
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
def describe_certificate_authority_audit_report(
self,
*,
CertificateAuthorityArn: str,
AuditReportId: str,
) -> DescribeCertificateAuthorityAuditReportResponseTypeDef: # (1)
...
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
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
def get_certificate(
self,
*,
CertificateAuthorityArn: str,
CertificateArn: str,
) -> GetCertificateResponseTypeDef: # (1)
...
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
def get_certificate_authority_certificate(
self,
*,
CertificateAuthorityArn: str,
) -> GetCertificateAuthorityCertificateResponseTypeDef: # (1)
...
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
def get_certificate_authority_csr(
self,
*,
CertificateAuthorityArn: str,
) -> GetCertificateAuthorityCsrResponseTypeDef: # (1)
...
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
def get_policy(
self,
*,
ResourceArn: str,
) -> GetPolicyResponseTypeDef: # (1)
...
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
def import_certificate_authority_certificate(
self,
*,
CertificateAuthorityArn: str,
Certificate: Union[str, bytes, IO[Any], StreamingBody],
CertificateChain: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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.
boto3 documentation
def issue_certificate(
self,
*,
CertificateAuthorityArn: str,
Csr: Union[str, bytes, IO[Any], StreamingBody],
SigningAlgorithm: SigningAlgorithmType, # (1)
Validity: ValidityTypeDef, # (2)
ApiPassthrough: ApiPassthroughTypeDef = ..., # (3)
TemplateArn: str = ...,
ValidityNotBefore: ValidityTypeDef = ..., # (2)
IdempotencyToken: str = ...,
) -> IssueCertificateResponseTypeDef: # (5)
...
- See SigningAlgorithmType
- See ValidityTypeDef
- See ApiPassthroughTypeDef
- See ValidityTypeDef
- See IssueCertificateResponseTypeDef
kwargs: IssueCertificateRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"Csr": ...,
"SigningAlgorithm": ...,
"Validity": ...,
}
parent.issue_certificate(**kwargs)
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
def list_certificate_authorities(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
ResourceOwner: ResourceOwnerType = ..., # (1)
) -> ListCertificateAuthoritiesResponseTypeDef: # (2)
...
kwargs: ListCertificateAuthoritiesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_certificate_authorities(**kwargs)
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
def list_permissions(
self,
*,
CertificateAuthorityArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPermissionsResponseTypeDef: # (1)
...
kwargs: ListPermissionsRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.list_permissions(**kwargs)
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
def list_tags(
self,
*,
CertificateAuthorityArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTagsResponseTypeDef: # (1)
...
kwargs: ListTagsRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.list_tags(**kwargs)
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
def put_policy(
self,
*,
ResourceArn: str,
Policy: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutPolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Policy": ...,
}
parent.put_policy(**kwargs)
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
def restore_certificate_authority(
self,
*,
CertificateAuthorityArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RestoreCertificateAuthorityRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.restore_certificate_authority(**kwargs)
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
def revoke_certificate(
self,
*,
CertificateAuthorityArn: str,
CertificateSerial: str,
RevocationReason: RevocationReasonType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: RevokeCertificateRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"CertificateSerial": ...,
"RevocationReason": ...,
}
parent.revoke_certificate(**kwargs)
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
def tag_certificate_authority(
self,
*,
CertificateAuthorityArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagCertificateAuthorityRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"Tags": ...,
}
parent.tag_certificate_authority(**kwargs)
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
def untag_certificate_authority(
self,
*,
CertificateAuthorityArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UntagCertificateAuthorityRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
"Tags": ...,
}
parent.untag_certificate_authority(**kwargs)
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
def update_certificate_authority(
self,
*,
CertificateAuthorityArn: str,
RevocationConfiguration: RevocationConfigurationTypeDef = ..., # (1)
Status: CertificateAuthorityStatusType = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See RevocationConfigurationTypeDef
- See CertificateAuthorityStatusType
- See EmptyResponseMetadataTypeDef
kwargs: UpdateCertificateAuthorityRequestRequestTypeDef = { # (1)
"CertificateAuthorityArn": ...,
}
parent.update_certificate_authority(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("acm-pca").get_paginator
method with overloads.
client.get_paginator("list_certificate_authorities")
-> ListCertificateAuthoritiesPaginatorclient.get_paginator("list_permissions")
-> ListPermissionsPaginatorclient.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")
-> AuditReportCreatedWaiterclient.get_waiter("certificate_authority_csr_created")
-> CertificateAuthorityCSRCreatedWaiterclient.get_waiter("certificate_issued")
-> CertificateIssuedWaiter