Struct rusoto_acm_pca::AcmPcaClient

pub struct AcmPcaClient { /* fields omitted */ }

A client for the ACM-PCA API.

Implementations

impl AcmPcaClient

pub fn new(region: Region) -> AcmPcaClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> AcmPcaClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> AcmPcaClient

Trait Implementations

impl AcmPca for AcmPcaClient

pub fn create_certificate_authority<'life0, 'async_trait>(
    &'life0 self,
    input: CreateCertificateAuthorityRequest
) -> Pin<Box<dyn Future<Output = Result<CreateCertificateAuthorityResponse, RusotoError<CreateCertificateAuthorityError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, 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 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.

pub fn create_certificate_authority_audit_report<'life0, 'async_trait>(
    &'life0 self,
    input: CreateCertificateAuthorityAuditReportRequest
) -> Pin<Box<dyn Future<Output = Result<CreateCertificateAuthorityAuditReportResponse, RusotoError<CreateCertificateAuthorityAuditReportError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.

pub fn create_permission<'life0, 'async_trait>(
    &'life0 self,
    input: CreatePermissionRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<CreatePermissionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.

At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission action and listed with the ListPermissions action.

pub fn delete_certificate_authority<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteCertificateAuthorityRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteCertificateAuthorityError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

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

pub fn delete_permission<'life0, 'async_trait>(
    &'life0 self,
    input: DeletePermissionRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeletePermissionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission action and listed with the ListPermissions action.

pub fn describe_certificate_authority<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeCertificateAuthorityRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeCertificateAuthorityResponse, RusotoError<DescribeCertificateAuthorityError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

• CREATING - ACM Private CA is creating your private certificate authority.

• PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

• ACTIVE - Your private CA is active.

• DISABLED - Your private CA has been disabled.

• EXPIRED - Your private CA certificate has expired.

• FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

• DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

pub fn describe_certificate_authority_audit_report<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeCertificateAuthorityAuditReportRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeCertificateAuthorityAuditReportResponse, RusotoError<DescribeCertificateAuthorityAuditReportError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn get_certificate<'life0, 'async_trait>(
    &'life0 self,
    input: GetCertificateRequest
) -> Pin<Box<dyn Future<Output = Result<GetCertificateResponse, RusotoError<GetCertificateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a certificate from your private CA. 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 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.

pub fn get_certificate_authority_certificate<'life0, 'async_trait>(
    &'life0 self,
    input: GetCertificateAuthorityCertificateRequest
) -> Pin<Box<dyn Future<Output = Result<GetCertificateAuthorityCertificateResponse, RusotoError<GetCertificateAuthorityCertificateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves the certificate and certificate chain for your private certificate authority (CA). 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.

pub fn get_certificate_authority_csr<'life0, 'async_trait>(
    &'life0 self,
    input: GetCertificateAuthorityCsrRequest
) -> Pin<Box<dyn Future<Output = Result<GetCertificateAuthorityCsrResponse, RusotoError<GetCertificateAuthorityCsrError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.

pub fn import_certificate_authority_certificate<'life0, 'async_trait>(
    &'life0 self,
    input: ImportCertificateAuthorityCertificateRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<ImportCertificateAuthorityCertificateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:

1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

3. Sign the CSR using a root or intermediate CA hosted either by an on-premises PKI hierarchy or a commercial CA..

4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

The following requirements apply when you import a CA certificate.

• You cannot import a non-self-signed certificate for use as a root CA.

• You cannot import a self-signed certificate for use as a subordinate CA.

• Your certificate chain must not include the private CA certificate that you are importing.

• Your ACM Private CA-hosted or on-premises CA certificate 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.

pub fn issue_certificate<'life0, 'async_trait>(
    &'life0 self,
    input: IssueCertificateRequest
) -> Pin<Box<dyn Future<Output = Result<IssueCertificateResponse, RusotoError<IssueCertificateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Uses your private certificate authority (CA) 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.

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.

pub fn list_certificate_authorities<'life0, 'async_trait>(
    &'life0 self,
    input: ListCertificateAuthoritiesRequest
) -> Pin<Box<dyn Future<Output = Result<ListCertificateAuthoritiesResponse, RusotoError<ListCertificateAuthoritiesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

pub fn list_permissions<'life0, 'async_trait>(
    &'life0 self,
    input: ListPermissionsRequest
) -> Pin<Box<dyn Future<Output = Result<ListPermissionsResponse, RusotoError<ListPermissionsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

pub fn list_tags<'life0, 'async_trait>(
    &'life0 self,
    input: ListTagsRequest
) -> Pin<Box<dyn Future<Output = Result<ListTagsResponse, RusotoError<ListTagsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the tags, if any, that are associated with your private CA. 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.

pub fn restore_certificate_authority<'life0, 'async_trait>(
    &'life0 self,
    input: RestoreCertificateAuthorityRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<RestoreCertificateAuthorityError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.

pub fn revoke_certificate<'life0, 'async_trait>(
    &'life0 self,
    input: RevokeCertificateRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<RevokeCertificateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Revokes a certificate that was issued inside ACM 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. ACM Private CA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

You cannot revoke a root CA self-signed certificate.

pub fn tag_certificate_authority<'life0, 'async_trait>(
    &'life0 self,
    input: TagCertificateAuthorityRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<TagCertificateAuthorityError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS 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.

pub fn untag_certificate_authority<'life0, 'async_trait>(
    &'life0 self,
    input: UntagCertificateAuthorityRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UntagCertificateAuthorityError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn update_certificate_authority<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateCertificateAuthorityRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateCertificateAuthorityError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

impl Clone for AcmPcaClient

pub fn clone(&self) -> AcmPcaClient

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.