Interface AcmClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AddTagsToCertificateResponseaddTagsToCertificate(Consumer<AddTagsToCertificateRequest.Builder> addTagsToCertificateRequest) Adds one or more tags to an ACM certificate.default AddTagsToCertificateResponseaddTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest) Adds one or more tags to an ACM certificate.static AcmClientBuilderbuilder()Create a builder that can be used to configure and create aAcmClient.static AcmClientcreate()Create aAcmClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAcmeDomainValidation(Consumer<CreateAcmeDomainValidationRequest.Builder> createAcmeDomainValidationRequest) Creates a domain validation for an ACME endpoint.createAcmeDomainValidation(CreateAcmeDomainValidationRequest createAcmeDomainValidationRequest) Creates a domain validation for an ACME endpoint.default CreateAcmeEndpointResponsecreateAcmeEndpoint(Consumer<CreateAcmeEndpointRequest.Builder> createAcmeEndpointRequest) Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL.default CreateAcmeEndpointResponsecreateAcmeEndpoint(CreateAcmeEndpointRequest createAcmeEndpointRequest) Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL.createAcmeExternalAccountBinding(Consumer<CreateAcmeExternalAccountBindingRequest.Builder> createAcmeExternalAccountBindingRequest) Creates an external account binding (EAB) for an ACME endpoint.createAcmeExternalAccountBinding(CreateAcmeExternalAccountBindingRequest createAcmeExternalAccountBindingRequest) Creates an external account binding (EAB) for an ACME endpoint.deleteAcmeDomainValidation(Consumer<DeleteAcmeDomainValidationRequest.Builder> deleteAcmeDomainValidationRequest) Deletes a domain validation.deleteAcmeDomainValidation(DeleteAcmeDomainValidationRequest deleteAcmeDomainValidationRequest) Deletes a domain validation.default DeleteAcmeEndpointResponsedeleteAcmeEndpoint(Consumer<DeleteAcmeEndpointRequest.Builder> deleteAcmeEndpointRequest) Deletes an ACME endpoint.default DeleteAcmeEndpointResponsedeleteAcmeEndpoint(DeleteAcmeEndpointRequest deleteAcmeEndpointRequest) Deletes an ACME endpoint.deleteAcmeExternalAccountBinding(Consumer<DeleteAcmeExternalAccountBindingRequest.Builder> deleteAcmeExternalAccountBindingRequest) Deletes an external account binding.deleteAcmeExternalAccountBinding(DeleteAcmeExternalAccountBindingRequest deleteAcmeExternalAccountBindingRequest) Deletes an external account binding.default DeleteCertificateResponsedeleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) Deletes a certificate and its associated private key.default DeleteCertificateResponsedeleteCertificate(DeleteCertificateRequest deleteCertificateRequest) Deletes a certificate and its associated private key.default DescribeAcmeAccountResponsedescribeAcmeAccount(Consumer<DescribeAcmeAccountRequest.Builder> describeAcmeAccountRequest) Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.default DescribeAcmeAccountResponsedescribeAcmeAccount(DescribeAcmeAccountRequest describeAcmeAccountRequest) Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.describeAcmeDomainValidation(Consumer<DescribeAcmeDomainValidationRequest.Builder> describeAcmeDomainValidationRequest) Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.describeAcmeDomainValidation(DescribeAcmeDomainValidationRequest describeAcmeDomainValidationRequest) Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.default DescribeAcmeEndpointResponsedescribeAcmeEndpoint(Consumer<DescribeAcmeEndpointRequest.Builder> describeAcmeEndpointRequest) Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.default DescribeAcmeEndpointResponsedescribeAcmeEndpoint(DescribeAcmeEndpointRequest describeAcmeEndpointRequest) Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.describeAcmeExternalAccountBinding(Consumer<DescribeAcmeExternalAccountBindingRequest.Builder> describeAcmeExternalAccountBindingRequest) Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.describeAcmeExternalAccountBinding(DescribeAcmeExternalAccountBindingRequest describeAcmeExternalAccountBindingRequest) Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.default DescribeCertificateResponsedescribeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) Returns detailed metadata about the specified ACM certificate.default DescribeCertificateResponsedescribeCertificate(DescribeCertificateRequest describeCertificateRequest) Returns detailed metadata about the specified ACM certificate.default ExportCertificateResponseexportCertificate(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest) Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere.default ExportCertificateResponseexportCertificate(ExportCertificateRequest exportCertificateRequest) Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere.default GetAccountConfigurationResponsegetAccountConfiguration(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest) Returns the account configuration options associated with an Amazon Web Services account.default GetAccountConfigurationResponsegetAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest) Returns the account configuration options associated with an Amazon Web Services account.getAcmeExternalAccountBindingCredentials(Consumer<GetAcmeExternalAccountBindingCredentialsRequest.Builder> getAcmeExternalAccountBindingCredentialsRequest) Retrieves the key ID and MAC key credentials for an external account binding.getAcmeExternalAccountBindingCredentials(GetAcmeExternalAccountBindingCredentialsRequest getAcmeExternalAccountBindingCredentialsRequest) Retrieves the key ID and MAC key credentials for an external account binding.default GetCertificateResponsegetCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest) Retrieves a certificate and its certificate chain.default GetCertificateResponsegetCertificate(GetCertificateRequest getCertificateRequest) Retrieves a certificate and its certificate chain.default ImportCertificateResponseimportCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.default ImportCertificateResponseimportCertificate(ImportCertificateRequest importCertificateRequest) Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.default ListAcmeAccountsResponselistAcmeAccounts(Consumer<ListAcmeAccountsRequest.Builder> listAcmeAccountsRequest) Retrieves a list of ACME accounts registered with the specified ACME endpoint.default ListAcmeAccountsResponselistAcmeAccounts(ListAcmeAccountsRequest listAcmeAccountsRequest) Retrieves a list of ACME accounts registered with the specified ACME endpoint.default ListAcmeAccountsIterablelistAcmeAccountsPaginator(Consumer<ListAcmeAccountsRequest.Builder> listAcmeAccountsRequest) This is a variant oflistAcmeAccounts(software.amazon.awssdk.services.acm.model.ListAcmeAccountsRequest)operation.default ListAcmeAccountsIterablelistAcmeAccountsPaginator(ListAcmeAccountsRequest listAcmeAccountsRequest) This is a variant oflistAcmeAccounts(software.amazon.awssdk.services.acm.model.ListAcmeAccountsRequest)operation.listAcmeDomainValidations(Consumer<ListAcmeDomainValidationsRequest.Builder> listAcmeDomainValidationsRequest) Retrieves a list of domain validations for the specified ACME endpoint.listAcmeDomainValidations(ListAcmeDomainValidationsRequest listAcmeDomainValidationsRequest) Retrieves a list of domain validations for the specified ACME endpoint.listAcmeDomainValidationsPaginator(Consumer<ListAcmeDomainValidationsRequest.Builder> listAcmeDomainValidationsRequest) This is a variant oflistAcmeDomainValidations(software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsRequest)operation.listAcmeDomainValidationsPaginator(ListAcmeDomainValidationsRequest listAcmeDomainValidationsRequest) This is a variant oflistAcmeDomainValidations(software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsRequest)operation.default ListAcmeEndpointsResponselistAcmeEndpoints(Consumer<ListAcmeEndpointsRequest.Builder> listAcmeEndpointsRequest) Retrieves a list of ACME endpoints in your account.default ListAcmeEndpointsResponselistAcmeEndpoints(ListAcmeEndpointsRequest listAcmeEndpointsRequest) Retrieves a list of ACME endpoints in your account.default ListAcmeEndpointsIterablelistAcmeEndpointsPaginator(Consumer<ListAcmeEndpointsRequest.Builder> listAcmeEndpointsRequest) This is a variant oflistAcmeEndpoints(software.amazon.awssdk.services.acm.model.ListAcmeEndpointsRequest)operation.default ListAcmeEndpointsIterablelistAcmeEndpointsPaginator(ListAcmeEndpointsRequest listAcmeEndpointsRequest) This is a variant oflistAcmeEndpoints(software.amazon.awssdk.services.acm.model.ListAcmeEndpointsRequest)operation.listAcmeExternalAccountBindings(Consumer<ListAcmeExternalAccountBindingsRequest.Builder> listAcmeExternalAccountBindingsRequest) Retrieves a list of external account bindings for the specified ACME endpoint.listAcmeExternalAccountBindings(ListAcmeExternalAccountBindingsRequest listAcmeExternalAccountBindingsRequest) Retrieves a list of external account bindings for the specified ACME endpoint.listAcmeExternalAccountBindingsPaginator(Consumer<ListAcmeExternalAccountBindingsRequest.Builder> listAcmeExternalAccountBindingsRequest) This is a variant oflistAcmeExternalAccountBindings(software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsRequest)operation.listAcmeExternalAccountBindingsPaginator(ListAcmeExternalAccountBindingsRequest listAcmeExternalAccountBindingsRequest) This is a variant oflistAcmeExternalAccountBindings(software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsRequest)operation.default ListCertificatesResponseRetrieves a list of certificate ARNs and domain names.default ListCertificatesResponselistCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) Retrieves a list of certificate ARNs and domain names.default ListCertificatesResponselistCertificates(ListCertificatesRequest listCertificatesRequest) Retrieves a list of certificate ARNs and domain names.default ListCertificatesIterableThis is a variant oflistCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation.default ListCertificatesIterablelistCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation.default ListCertificatesIterablelistCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation.default ListTagsForCertificateResponselistTagsForCertificate(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest) Lists the tags that have been applied to the ACM certificate.default ListTagsForCertificateResponselistTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest) Lists the tags that have been applied to the ACM certificate.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with an ACM resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with an ACM resource.default PutAccountConfigurationResponseputAccountConfiguration(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest) Adds or modifies account-level configurations in ACM.default PutAccountConfigurationResponseputAccountConfiguration(PutAccountConfigurationRequest putAccountConfigurationRequest) Adds or modifies account-level configurations in ACM.removeTagsFromCertificate(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest) Remove one or more tags from an ACM certificate.removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest) Remove one or more tags from an ACM certificate.default RenewCertificateResponserenewCertificate(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest) Renews an eligible ACM certificate.default RenewCertificateResponserenewCertificate(RenewCertificateRequest renewCertificateRequest) Renews an eligible ACM certificate.default RequestCertificateResponserequestCertificate(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest) Requests an ACM certificate for use with other Amazon Web Services services.default RequestCertificateResponserequestCertificate(RequestCertificateRequest requestCertificateRequest) Requests an ACM certificate for use with other Amazon Web Services services.default ResendValidationEmailResponseresendValidationEmail(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest) Resends the email that requests domain ownership validation.default ResendValidationEmailResponseresendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest) Resends the email that requests domain ownership validation.default RevokeAcmeAccountResponserevokeAcmeAccount(Consumer<RevokeAcmeAccountRequest.Builder> revokeAcmeAccountRequest) Revokes an ACME account, preventing it from requesting or revoking certificates.default RevokeAcmeAccountResponserevokeAcmeAccount(RevokeAcmeAccountRequest revokeAcmeAccountRequest) Revokes an ACME account, preventing it from requesting or revoking certificates.revokeAcmeExternalAccountBinding(Consumer<RevokeAcmeExternalAccountBindingRequest.Builder> revokeAcmeExternalAccountBindingRequest) Revokes an external account binding, preventing new ACME accounts from being registered using this binding.revokeAcmeExternalAccountBinding(RevokeAcmeExternalAccountBindingRequest revokeAcmeExternalAccountBindingRequest) Revokes an external account binding, preventing new ACME accounts from being registered using this binding.default RevokeCertificateResponserevokeCertificate(Consumer<RevokeCertificateRequest.Builder> revokeCertificateRequest) Revokes a public ACM certificate.default RevokeCertificateResponserevokeCertificate(RevokeCertificateRequest revokeCertificateRequest) Revokes a public ACM certificate.default SearchCertificatesResponsesearchCertificates(Consumer<SearchCertificatesRequest.Builder> searchCertificatesRequest) Retrieves a list of certificates matching search criteria.default SearchCertificatesResponsesearchCertificates(SearchCertificatesRequest searchCertificatesRequest) Retrieves a list of certificates matching search criteria.default SearchCertificatesIterablesearchCertificatesPaginator(Consumer<SearchCertificatesRequest.Builder> searchCertificatesRequest) This is a variant ofsearchCertificates(software.amazon.awssdk.services.acm.model.SearchCertificatesRequest)operation.default SearchCertificatesIterablesearchCertificatesPaginator(SearchCertificatesRequest searchCertificatesRequest) This is a variant ofsearchCertificates(software.amazon.awssdk.services.acm.model.SearchCertificatesRequest)operation.default AcmServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to an ACM resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to an ACM resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from an ACM resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from an ACM resource.updateAcmeDomainValidation(Consumer<UpdateAcmeDomainValidationRequest.Builder> updateAcmeDomainValidationRequest) Updates the prevalidation configuration of an existing domain validation.updateAcmeDomainValidation(UpdateAcmeDomainValidationRequest updateAcmeDomainValidationRequest) Updates the prevalidation configuration of an existing domain validation.default UpdateAcmeEndpointResponseupdateAcmeEndpoint(Consumer<UpdateAcmeEndpointRequest.Builder> updateAcmeEndpointRequest) Updates the configuration of an existing ACME endpoint.default UpdateAcmeEndpointResponseupdateAcmeEndpoint(UpdateAcmeEndpointRequest updateAcmeEndpointRequest) Updates the configuration of an existing ACME endpoint.default UpdateCertificateOptionsResponseupdateCertificateOptions(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest) Updates a certificate.default UpdateCertificateOptionsResponseupdateCertificateOptions(UpdateCertificateOptionsRequest updateCertificateOptionsRequest) Updates a certificate.default AcmWaiterwaiter()Create an instance ofAcmWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
addTagsToCertificate
default AddTagsToCertificateResponse addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest) throws InvalidParameterException, TagPolicyException, TooManyTagsException, InvalidArnException, InvalidTagException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a
keyand an optionalvalue. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.This action applies only to the
certificateresource type. For all other ACM resource types, use TagResource instead.You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
- Parameters:
addTagsToCertificateRequest-- Returns:
- Result of the AddTagsToCertificate operation returned by the service.
- See Also:
-
addTagsToCertificate
default AddTagsToCertificateResponse addTagsToCertificate(Consumer<AddTagsToCertificateRequest.Builder> addTagsToCertificateRequest) throws InvalidParameterException, TagPolicyException, TooManyTagsException, InvalidArnException, InvalidTagException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a
keyand an optionalvalue. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.This action applies only to the
certificateresource type. For all other ACM resource types, use TagResource instead.You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
This is a convenience which creates an instance of the
AddTagsToCertificateRequest.Builderavoiding the need to create one manually viaAddTagsToCertificateRequest.builder()- Parameters:
addTagsToCertificateRequest- AConsumerthat will call methods onAddTagsToCertificateRequest.Builderto create a request.- Returns:
- Result of the AddTagsToCertificate operation returned by the service.
- See Also:
-
createAcmeDomainValidation
default CreateAcmeDomainValidationResponse createAcmeDomainValidation(CreateAcmeDomainValidationRequest createAcmeDomainValidationRequest) throws InternalServerException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Creates a domain validation for an ACME endpoint. Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership.
- Parameters:
createAcmeDomainValidationRequest-- Returns:
- Result of the CreateAcmeDomainValidation operation returned by the service.
- See Also:
-
createAcmeDomainValidation
default CreateAcmeDomainValidationResponse createAcmeDomainValidation(Consumer<CreateAcmeDomainValidationRequest.Builder> createAcmeDomainValidationRequest) throws InternalServerException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Creates a domain validation for an ACME endpoint. Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership.
This is a convenience which creates an instance of the
CreateAcmeDomainValidationRequest.Builderavoiding the need to create one manually viaCreateAcmeDomainValidationRequest.builder()- Parameters:
createAcmeDomainValidationRequest- AConsumerthat will call methods onCreateAcmeDomainValidationRequest.Builderto create a request.- Returns:
- Result of the CreateAcmeDomainValidation operation returned by the service.
- See Also:
-
createAcmeEndpoint
default CreateAcmeEndpointResponse createAcmeEndpoint(CreateAcmeEndpointRequest createAcmeEndpointRequest) throws InternalServerException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL. After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol.
- Parameters:
createAcmeEndpointRequest-- Returns:
- Result of the CreateAcmeEndpoint operation returned by the service.
- See Also:
-
createAcmeEndpoint
default CreateAcmeEndpointResponse createAcmeEndpoint(Consumer<CreateAcmeEndpointRequest.Builder> createAcmeEndpointRequest) throws InternalServerException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL. After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol.
This is a convenience which creates an instance of the
CreateAcmeEndpointRequest.Builderavoiding the need to create one manually viaCreateAcmeEndpointRequest.builder()- Parameters:
createAcmeEndpointRequest- AConsumerthat will call methods onCreateAcmeEndpointRequest.Builderto create a request.- Returns:
- Result of the CreateAcmeEndpoint operation returned by the service.
- See Also:
-
createAcmeExternalAccountBinding
default CreateAcmeExternalAccountBindingResponse createAcmeExternalAccountBinding(CreateAcmeExternalAccountBindingRequest createAcmeExternalAccountBindingRequest) throws InternalServerException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.
- Parameters:
createAcmeExternalAccountBindingRequest-- Returns:
- Result of the CreateAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
createAcmeExternalAccountBinding
default CreateAcmeExternalAccountBindingResponse createAcmeExternalAccountBinding(Consumer<CreateAcmeExternalAccountBindingRequest.Builder> createAcmeExternalAccountBindingRequest) throws InternalServerException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.
This is a convenience which creates an instance of the
CreateAcmeExternalAccountBindingRequest.Builderavoiding the need to create one manually viaCreateAcmeExternalAccountBindingRequest.builder()- Parameters:
createAcmeExternalAccountBindingRequest- AConsumerthat will call methods onCreateAcmeExternalAccountBindingRequest.Builderto create a request.- Returns:
- Result of the CreateAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
deleteAcmeDomainValidation
default DeleteAcmeDomainValidationResponse deleteAcmeDomainValidation(DeleteAcmeDomainValidationRequest deleteAcmeDomainValidationRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes a domain validation. After deletion, the ACME endpoint can no longer issue certificates for the associated domain.
- Parameters:
deleteAcmeDomainValidationRequest-- Returns:
- Result of the DeleteAcmeDomainValidation operation returned by the service.
- See Also:
-
deleteAcmeDomainValidation
default DeleteAcmeDomainValidationResponse deleteAcmeDomainValidation(Consumer<DeleteAcmeDomainValidationRequest.Builder> deleteAcmeDomainValidationRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes a domain validation. After deletion, the ACME endpoint can no longer issue certificates for the associated domain.
This is a convenience which creates an instance of the
DeleteAcmeDomainValidationRequest.Builderavoiding the need to create one manually viaDeleteAcmeDomainValidationRequest.builder()- Parameters:
deleteAcmeDomainValidationRequest- AConsumerthat will call methods onDeleteAcmeDomainValidationRequest.Builderto create a request.- Returns:
- Result of the DeleteAcmeDomainValidation operation returned by the service.
- See Also:
-
deleteAcmeEndpoint
default DeleteAcmeEndpointResponse deleteAcmeEndpoint(DeleteAcmeEndpointRequest deleteAcmeEndpointRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes an ACME endpoint. After deletion, the endpoint URL is no longer accessible and ACME clients cannot issue certificates through it. Any existing external account bindings and domain validations associated with the endpoint are also deleted.
- Parameters:
deleteAcmeEndpointRequest-- Returns:
- Result of the DeleteAcmeEndpoint operation returned by the service.
- See Also:
-
deleteAcmeEndpoint
default DeleteAcmeEndpointResponse deleteAcmeEndpoint(Consumer<DeleteAcmeEndpointRequest.Builder> deleteAcmeEndpointRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes an ACME endpoint. After deletion, the endpoint URL is no longer accessible and ACME clients cannot issue certificates through it. Any existing external account bindings and domain validations associated with the endpoint are also deleted.
This is a convenience which creates an instance of the
DeleteAcmeEndpointRequest.Builderavoiding the need to create one manually viaDeleteAcmeEndpointRequest.builder()- Parameters:
deleteAcmeEndpointRequest- AConsumerthat will call methods onDeleteAcmeEndpointRequest.Builderto create a request.- Returns:
- Result of the DeleteAcmeEndpoint operation returned by the service.
- See Also:
-
deleteAcmeExternalAccountBinding
default DeleteAcmeExternalAccountBindingResponse deleteAcmeExternalAccountBinding(DeleteAcmeExternalAccountBindingRequest deleteAcmeExternalAccountBindingRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes an external account binding. Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered.
- Parameters:
deleteAcmeExternalAccountBindingRequest-- Returns:
- Result of the DeleteAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
deleteAcmeExternalAccountBinding
default DeleteAcmeExternalAccountBindingResponse deleteAcmeExternalAccountBinding(Consumer<DeleteAcmeExternalAccountBindingRequest.Builder> deleteAcmeExternalAccountBindingRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes an external account binding. Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered.
This is a convenience which creates an instance of the
DeleteAcmeExternalAccountBindingRequest.Builderavoiding the need to create one manually viaDeleteAcmeExternalAccountBindingRequest.builder()- Parameters:
deleteAcmeExternalAccountBindingRequest- AConsumerthat will call methods onDeleteAcmeExternalAccountBindingRequest.Builderto create a request.- Returns:
- Result of the DeleteAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
deleteCertificate
default DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws ResourceInUseException, InvalidArnException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes a certificate and its associated private key. If this action succeeds, the certificate is not available for use by Amazon Web Services services integrated with ACM. Deleting a certificate is eventually consistent. The may be a short delay before the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, you must first remove the certificate association using the console or the CLI for the associated service.
Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting Your Private CA in the Private Certificate Authority User Guide.
You cannot delete a certificate with a
CertificateKeyPairOriginofACME. ACM automatically deletes these certificates 1 year after they expire.Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting your private CA in the Amazon Web Services Private Certificate Authority User Guide.
- Parameters:
deleteCertificateRequest-- Returns:
- Result of the DeleteCertificate operation returned by the service.
- See Also:
-
deleteCertificate
default DeleteCertificateResponse deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) throws ResourceInUseException, InvalidArnException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Deletes a certificate and its associated private key. If this action succeeds, the certificate is not available for use by Amazon Web Services services integrated with ACM. Deleting a certificate is eventually consistent. The may be a short delay before the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, you must first remove the certificate association using the console or the CLI for the associated service.
Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting Your Private CA in the Private Certificate Authority User Guide.
You cannot delete a certificate with a
CertificateKeyPairOriginofACME. ACM automatically deletes these certificates 1 year after they expire.Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting your private CA in the Amazon Web Services Private Certificate Authority User Guide.
This is a convenience which creates an instance of the
DeleteCertificateRequest.Builderavoiding the need to create one manually viaDeleteCertificateRequest.builder()- Parameters:
deleteCertificateRequest- AConsumerthat will call methods onDeleteCertificateRequest.Builderto create a request.- Returns:
- Result of the DeleteCertificate operation returned by the service.
- See Also:
-
describeAcmeAccount
default DescribeAcmeAccountResponse describeAcmeAccount(DescribeAcmeAccountRequest describeAcmeAccountRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.
- Parameters:
describeAcmeAccountRequest-- Returns:
- Result of the DescribeAcmeAccount operation returned by the service.
- See Also:
-
describeAcmeAccount
default DescribeAcmeAccountResponse describeAcmeAccount(Consumer<DescribeAcmeAccountRequest.Builder> describeAcmeAccountRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.
This is a convenience which creates an instance of the
DescribeAcmeAccountRequest.Builderavoiding the need to create one manually viaDescribeAcmeAccountRequest.builder()- Parameters:
describeAcmeAccountRequest- AConsumerthat will call methods onDescribeAcmeAccountRequest.Builderto create a request.- Returns:
- Result of the DescribeAcmeAccount operation returned by the service.
- See Also:
-
describeAcmeDomainValidation
default DescribeAcmeDomainValidationResponse describeAcmeDomainValidation(DescribeAcmeDomainValidationRequest describeAcmeDomainValidationRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.
- Parameters:
describeAcmeDomainValidationRequest-- Returns:
- Result of the DescribeAcmeDomainValidation operation returned by the service.
- See Also:
-
describeAcmeDomainValidation
default DescribeAcmeDomainValidationResponse describeAcmeDomainValidation(Consumer<DescribeAcmeDomainValidationRequest.Builder> describeAcmeDomainValidationRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.
This is a convenience which creates an instance of the
DescribeAcmeDomainValidationRequest.Builderavoiding the need to create one manually viaDescribeAcmeDomainValidationRequest.builder()- Parameters:
describeAcmeDomainValidationRequest- AConsumerthat will call methods onDescribeAcmeDomainValidationRequest.Builderto create a request.- Returns:
- Result of the DescribeAcmeDomainValidation operation returned by the service.
- See Also:
-
describeAcmeEndpoint
default DescribeAcmeEndpointResponse describeAcmeEndpoint(DescribeAcmeEndpointRequest describeAcmeEndpointRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.
- Parameters:
describeAcmeEndpointRequest-- Returns:
- Result of the DescribeAcmeEndpoint operation returned by the service.
- See Also:
-
describeAcmeEndpoint
default DescribeAcmeEndpointResponse describeAcmeEndpoint(Consumer<DescribeAcmeEndpointRequest.Builder> describeAcmeEndpointRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.
This is a convenience which creates an instance of the
DescribeAcmeEndpointRequest.Builderavoiding the need to create one manually viaDescribeAcmeEndpointRequest.builder()- Parameters:
describeAcmeEndpointRequest- AConsumerthat will call methods onDescribeAcmeEndpointRequest.Builderto create a request.- Returns:
- Result of the DescribeAcmeEndpoint operation returned by the service.
- See Also:
-
describeAcmeExternalAccountBinding
default DescribeAcmeExternalAccountBindingResponse describeAcmeExternalAccountBinding(DescribeAcmeExternalAccountBindingRequest describeAcmeExternalAccountBindingRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.
- Parameters:
describeAcmeExternalAccountBindingRequest-- Returns:
- Result of the DescribeAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
describeAcmeExternalAccountBinding
default DescribeAcmeExternalAccountBindingResponse describeAcmeExternalAccountBinding(Consumer<DescribeAcmeExternalAccountBindingRequest.Builder> describeAcmeExternalAccountBindingRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.
This is a convenience which creates an instance of the
DescribeAcmeExternalAccountBindingRequest.Builderavoiding the need to create one manually viaDescribeAcmeExternalAccountBindingRequest.builder()- Parameters:
describeAcmeExternalAccountBindingRequest- AConsumerthat will call methods onDescribeAcmeExternalAccountBindingRequest.Builderto create a request.- Returns:
- Result of the DescribeAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
describeCertificate
default DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws InvalidArnException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified ACM certificate.
If you have just created a certificate using the
RequestCertificateaction, there is a delay of several seconds before you can retrieve information about it.- Parameters:
describeCertificateRequest-- Returns:
- Result of the DescribeCertificate operation returned by the service.
- See Also:
-
describeCertificate
default DescribeCertificateResponse describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) throws InvalidArnException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Returns detailed metadata about the specified ACM certificate.
If you have just created a certificate using the
RequestCertificateaction, there is a delay of several seconds before you can retrieve information about it.
This is a convenience which creates an instance of the
DescribeCertificateRequest.Builderavoiding the need to create one manually viaDescribeCertificateRequest.builder()- Parameters:
describeCertificateRequest- AConsumerthat will call methods onDescribeCertificateRequest.Builderto create a request.- Returns:
- Result of the DescribeCertificate operation returned by the service.
- See Also:
-
exportCertificate
default ExportCertificateResponse exportCertificate(ExportCertificateRequest exportCertificateRequest) throws InvalidArnException, RequestInProgressException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.
For information about exporting and formatting a certificate using the ACM console or CLI, see Export a private certificate and Export a public certificate.
ACM public certificates created prior to June 17, 2025 cannot be exported.
- Parameters:
exportCertificateRequest-- Returns:
- Result of the ExportCertificate operation returned by the service.
- See Also:
-
exportCertificate
default ExportCertificateResponse exportCertificate(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest) throws InvalidArnException, RequestInProgressException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.
For information about exporting and formatting a certificate using the ACM console or CLI, see Export a private certificate and Export a public certificate.
ACM public certificates created prior to June 17, 2025 cannot be exported.
This is a convenience which creates an instance of the
ExportCertificateRequest.Builderavoiding the need to create one manually viaExportCertificateRequest.builder()- Parameters:
exportCertificateRequest- AConsumerthat will call methods onExportCertificateRequest.Builderto create a request.- Returns:
- Result of the ExportCertificate operation returned by the service.
- See Also:
-
getAccountConfiguration
default GetAccountConfigurationResponse getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest) throws AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns the account configuration options associated with an Amazon Web Services account.
- Parameters:
getAccountConfigurationRequest-- Returns:
- Result of the GetAccountConfiguration operation returned by the service.
- See Also:
-
getAccountConfiguration
default GetAccountConfigurationResponse getAccountConfiguration(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest) throws AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Returns the account configuration options associated with an Amazon Web Services account.
This is a convenience which creates an instance of the
GetAccountConfigurationRequest.Builderavoiding the need to create one manually viaGetAccountConfigurationRequest.builder()- Parameters:
getAccountConfigurationRequest- AConsumerthat will call methods onGetAccountConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetAccountConfiguration operation returned by the service.
- See Also:
-
getAcmeExternalAccountBindingCredentials
default GetAcmeExternalAccountBindingCredentialsResponse getAcmeExternalAccountBindingCredentials(GetAcmeExternalAccountBindingCredentialsRequest getAcmeExternalAccountBindingCredentialsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves the key ID and MAC key credentials for an external account binding. These credentials are used by ACME clients during account registration to bind to the endpoint.
- Parameters:
getAcmeExternalAccountBindingCredentialsRequest-- Returns:
- Result of the GetAcmeExternalAccountBindingCredentials operation returned by the service.
- See Also:
-
getAcmeExternalAccountBindingCredentials
default GetAcmeExternalAccountBindingCredentialsResponse getAcmeExternalAccountBindingCredentials(Consumer<GetAcmeExternalAccountBindingCredentialsRequest.Builder> getAcmeExternalAccountBindingCredentialsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves the key ID and MAC key credentials for an external account binding. These credentials are used by ACME clients during account registration to bind to the endpoint.
This is a convenience which creates an instance of the
GetAcmeExternalAccountBindingCredentialsRequest.Builderavoiding the need to create one manually viaGetAcmeExternalAccountBindingCredentialsRequest.builder()- Parameters:
getAcmeExternalAccountBindingCredentialsRequest- AConsumerthat will call methods onGetAcmeExternalAccountBindingCredentialsRequest.Builderto create a request.- Returns:
- Result of the GetAcmeExternalAccountBindingCredentials operation returned by the service.
- See Also:
-
getCertificate
default GetCertificateResponse getCertificate(GetCertificateRequest getCertificateRequest) throws InvalidArnException, RequestInProgressException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM
RequestCertificateaction, or a certificate imported into ACM using theImportCertificateaction. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.- Parameters:
getCertificateRequest-- Returns:
- Result of the GetCertificate operation returned by the service.
- See Also:
-
getCertificate
default GetCertificateResponse getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest) throws InvalidArnException, RequestInProgressException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM
RequestCertificateaction, or a certificate imported into ACM using theImportCertificateaction. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.
This is a convenience which creates an instance of the
GetCertificateRequest.Builderavoiding the need to create one manually viaGetCertificateRequest.builder()- Parameters:
getCertificateRequest- AConsumerthat will call methods onGetCertificateRequest.Builderto create a request.- Returns:
- Result of the GetCertificate operation returned by the service.
- See Also:
-
importCertificate
default ImportCertificateResponse importCertificate(ImportCertificateRequest importCertificateRequest) throws InvalidParameterException, TagPolicyException, TooManyTagsException, InvalidArnException, InvalidTagException, ConflictException, LimitExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
-
You must enter the private key that matches the certificate you are importing.
-
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
-
The private key must be no larger than 5 KB (5,120 bytes).
-
The certificate, private key, and certificate chain must be PEM-encoded.
-
The current time must be between the
Not BeforeandNot Aftercertificate fields. -
The
Issuerfield must not be empty. -
The OCSP authority URL, if present, must not exceed 1000 characters.
-
To import a new certificate, omit the
CertificateArnargument. Include this argument only when you want to replace a previously imported certificate. -
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by
fileb://. For example, you can specify a certificate saved in theC:\tempfolder asfileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. -
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
-
The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
- Parameters:
importCertificateRequest-- Returns:
- Result of the ImportCertificate operation returned by the service.
- See Also:
-
-
importCertificate
default ImportCertificateResponse importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) throws InvalidParameterException, TagPolicyException, TooManyTagsException, InvalidArnException, InvalidTagException, ConflictException, LimitExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
-
You must enter the private key that matches the certificate you are importing.
-
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
-
The private key must be no larger than 5 KB (5,120 bytes).
-
The certificate, private key, and certificate chain must be PEM-encoded.
-
The current time must be between the
Not BeforeandNot Aftercertificate fields. -
The
Issuerfield must not be empty. -
The OCSP authority URL, if present, must not exceed 1000 characters.
-
To import a new certificate, omit the
CertificateArnargument. Include this argument only when you want to replace a previously imported certificate. -
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by
fileb://. For example, you can specify a certificate saved in theC:\tempfolder asfileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. -
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
-
The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
This is a convenience which creates an instance of the
ImportCertificateRequest.Builderavoiding the need to create one manually viaImportCertificateRequest.builder()- Parameters:
importCertificateRequest- AConsumerthat will call methods onImportCertificateRequest.Builderto create a request.- Returns:
- Result of the ImportCertificate operation returned by the service.
- See Also:
-
-
listAcmeAccounts
default ListAcmeAccountsResponse listAcmeAccounts(ListAcmeAccountsRequest listAcmeAccountsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register.
- Parameters:
listAcmeAccountsRequest-- Returns:
- Result of the ListAcmeAccounts operation returned by the service.
- See Also:
-
listAcmeAccounts
default ListAcmeAccountsResponse listAcmeAccounts(Consumer<ListAcmeAccountsRequest.Builder> listAcmeAccountsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register.
This is a convenience which creates an instance of the
ListAcmeAccountsRequest.Builderavoiding the need to create one manually viaListAcmeAccountsRequest.builder()- Parameters:
listAcmeAccountsRequest- AConsumerthat will call methods onListAcmeAccountsRequest.Builderto create a request.- Returns:
- Result of the ListAcmeAccounts operation returned by the service.
- See Also:
-
listAcmeAccountsPaginator
default ListAcmeAccountsIterable listAcmeAccountsPaginator(ListAcmeAccountsRequest listAcmeAccountsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeAccounts(software.amazon.awssdk.services.acm.model.ListAcmeAccountsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeAccountsIterable responses = client.listAcmeAccountsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeAccountsIterable responses = client.listAcmeAccountsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeAccountsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeAccountsIterable responses = client.listAcmeAccountsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeAccounts(software.amazon.awssdk.services.acm.model.ListAcmeAccountsRequest)operation.- Parameters:
listAcmeAccountsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAcmeAccountsPaginator
default ListAcmeAccountsIterable listAcmeAccountsPaginator(Consumer<ListAcmeAccountsRequest.Builder> listAcmeAccountsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeAccounts(software.amazon.awssdk.services.acm.model.ListAcmeAccountsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeAccountsIterable responses = client.listAcmeAccountsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeAccountsIterable responses = client.listAcmeAccountsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeAccountsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeAccountsIterable responses = client.listAcmeAccountsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeAccounts(software.amazon.awssdk.services.acm.model.ListAcmeAccountsRequest)operation.
This is a convenience which creates an instance of the
ListAcmeAccountsRequest.Builderavoiding the need to create one manually viaListAcmeAccountsRequest.builder()- Parameters:
listAcmeAccountsRequest- AConsumerthat will call methods onListAcmeAccountsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAcmeDomainValidations
default ListAcmeDomainValidationsResponse listAcmeDomainValidations(ListAcmeDomainValidationsRequest listAcmeDomainValidationsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of domain validations for the specified ACME endpoint.
- Parameters:
listAcmeDomainValidationsRequest-- Returns:
- Result of the ListAcmeDomainValidations operation returned by the service.
- See Also:
-
listAcmeDomainValidations
default ListAcmeDomainValidationsResponse listAcmeDomainValidations(Consumer<ListAcmeDomainValidationsRequest.Builder> listAcmeDomainValidationsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of domain validations for the specified ACME endpoint.
This is a convenience which creates an instance of the
ListAcmeDomainValidationsRequest.Builderavoiding the need to create one manually viaListAcmeDomainValidationsRequest.builder()- Parameters:
listAcmeDomainValidationsRequest- AConsumerthat will call methods onListAcmeDomainValidationsRequest.Builderto create a request.- Returns:
- Result of the ListAcmeDomainValidations operation returned by the service.
- See Also:
-
listAcmeDomainValidationsPaginator
default ListAcmeDomainValidationsIterable listAcmeDomainValidationsPaginator(ListAcmeDomainValidationsRequest listAcmeDomainValidationsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeDomainValidations(software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeDomainValidationsIterable responses = client.listAcmeDomainValidationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeDomainValidationsIterable responses = client .listAcmeDomainValidationsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeDomainValidationsIterable responses = client.listAcmeDomainValidationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeDomainValidations(software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsRequest)operation.- Parameters:
listAcmeDomainValidationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAcmeDomainValidationsPaginator
default ListAcmeDomainValidationsIterable listAcmeDomainValidationsPaginator(Consumer<ListAcmeDomainValidationsRequest.Builder> listAcmeDomainValidationsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeDomainValidations(software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeDomainValidationsIterable responses = client.listAcmeDomainValidationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeDomainValidationsIterable responses = client .listAcmeDomainValidationsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeDomainValidationsIterable responses = client.listAcmeDomainValidationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeDomainValidations(software.amazon.awssdk.services.acm.model.ListAcmeDomainValidationsRequest)operation.
This is a convenience which creates an instance of the
ListAcmeDomainValidationsRequest.Builderavoiding the need to create one manually viaListAcmeDomainValidationsRequest.builder()- Parameters:
listAcmeDomainValidationsRequest- AConsumerthat will call methods onListAcmeDomainValidationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAcmeEndpoints
default ListAcmeEndpointsResponse listAcmeEndpoints(ListAcmeEndpointsRequest listAcmeEndpointsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status.
- Parameters:
listAcmeEndpointsRequest-- Returns:
- Result of the ListAcmeEndpoints operation returned by the service.
- See Also:
-
listAcmeEndpoints
default ListAcmeEndpointsResponse listAcmeEndpoints(Consumer<ListAcmeEndpointsRequest.Builder> listAcmeEndpointsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status.
This is a convenience which creates an instance of the
ListAcmeEndpointsRequest.Builderavoiding the need to create one manually viaListAcmeEndpointsRequest.builder()- Parameters:
listAcmeEndpointsRequest- AConsumerthat will call methods onListAcmeEndpointsRequest.Builderto create a request.- Returns:
- Result of the ListAcmeEndpoints operation returned by the service.
- See Also:
-
listAcmeEndpointsPaginator
default ListAcmeEndpointsIterable listAcmeEndpointsPaginator(ListAcmeEndpointsRequest listAcmeEndpointsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeEndpoints(software.amazon.awssdk.services.acm.model.ListAcmeEndpointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeEndpointsIterable responses = client.listAcmeEndpointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeEndpointsIterable responses = client .listAcmeEndpointsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeEndpointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeEndpointsIterable responses = client.listAcmeEndpointsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeEndpoints(software.amazon.awssdk.services.acm.model.ListAcmeEndpointsRequest)operation.- Parameters:
listAcmeEndpointsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAcmeEndpointsPaginator
default ListAcmeEndpointsIterable listAcmeEndpointsPaginator(Consumer<ListAcmeEndpointsRequest.Builder> listAcmeEndpointsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeEndpoints(software.amazon.awssdk.services.acm.model.ListAcmeEndpointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeEndpointsIterable responses = client.listAcmeEndpointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeEndpointsIterable responses = client .listAcmeEndpointsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeEndpointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeEndpointsIterable responses = client.listAcmeEndpointsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeEndpoints(software.amazon.awssdk.services.acm.model.ListAcmeEndpointsRequest)operation.
This is a convenience which creates an instance of the
ListAcmeEndpointsRequest.Builderavoiding the need to create one manually viaListAcmeEndpointsRequest.builder()- Parameters:
listAcmeEndpointsRequest- AConsumerthat will call methods onListAcmeEndpointsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAcmeExternalAccountBindings
default ListAcmeExternalAccountBindingsResponse listAcmeExternalAccountBindings(ListAcmeExternalAccountBindingsRequest listAcmeExternalAccountBindingsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of external account bindings for the specified ACME endpoint.
- Parameters:
listAcmeExternalAccountBindingsRequest-- Returns:
- Result of the ListAcmeExternalAccountBindings operation returned by the service.
- See Also:
-
listAcmeExternalAccountBindings
default ListAcmeExternalAccountBindingsResponse listAcmeExternalAccountBindings(Consumer<ListAcmeExternalAccountBindingsRequest.Builder> listAcmeExternalAccountBindingsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of external account bindings for the specified ACME endpoint.
This is a convenience which creates an instance of the
ListAcmeExternalAccountBindingsRequest.Builderavoiding the need to create one manually viaListAcmeExternalAccountBindingsRequest.builder()- Parameters:
listAcmeExternalAccountBindingsRequest- AConsumerthat will call methods onListAcmeExternalAccountBindingsRequest.Builderto create a request.- Returns:
- Result of the ListAcmeExternalAccountBindings operation returned by the service.
- See Also:
-
listAcmeExternalAccountBindingsPaginator
default ListAcmeExternalAccountBindingsIterable listAcmeExternalAccountBindingsPaginator(ListAcmeExternalAccountBindingsRequest listAcmeExternalAccountBindingsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeExternalAccountBindings(software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeExternalAccountBindingsIterable responses = client.listAcmeExternalAccountBindingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeExternalAccountBindingsIterable responses = client .listAcmeExternalAccountBindingsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeExternalAccountBindingsIterable responses = client.listAcmeExternalAccountBindingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeExternalAccountBindings(software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsRequest)operation.- Parameters:
listAcmeExternalAccountBindingsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAcmeExternalAccountBindingsPaginator
default ListAcmeExternalAccountBindingsIterable listAcmeExternalAccountBindingsPaginator(Consumer<ListAcmeExternalAccountBindingsRequest.Builder> listAcmeExternalAccountBindingsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
listAcmeExternalAccountBindings(software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListAcmeExternalAccountBindingsIterable responses = client.listAcmeExternalAccountBindingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListAcmeExternalAccountBindingsIterable responses = client .listAcmeExternalAccountBindingsPaginator(request); for (software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListAcmeExternalAccountBindingsIterable responses = client.listAcmeExternalAccountBindingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAcmeExternalAccountBindings(software.amazon.awssdk.services.acm.model.ListAcmeExternalAccountBindingsRequest)operation.
This is a convenience which creates an instance of the
ListAcmeExternalAccountBindingsRequest.Builderavoiding the need to create one manually viaListAcmeExternalAccountBindingsRequest.builder()- Parameters:
listAcmeExternalAccountBindingsRequest- AConsumerthat will call methods onListAcmeExternalAccountBindingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCertificates
default ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only
RSA_2048certificates. For more information, see Filters.By default, this action does not return certificates with a
CertificateKeyPairOriginofACME. To include ACME certificates, specifyACMEin theCertificateKeyPairOriginsfilter.- Parameters:
listCertificatesRequest-- Returns:
- Result of the ListCertificates operation returned by the service.
- See Also:
-
listCertificates
default ListCertificatesResponse listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only
RSA_2048certificates. For more information, see Filters.By default, this action does not return certificates with a
CertificateKeyPairOriginofACME. To include ACME certificates, specifyACMEin theCertificateKeyPairOriginsfilter.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builderavoiding the need to create one manually viaListCertificatesRequest.builder()- Parameters:
listCertificatesRequest- AConsumerthat will call methods onListCertificatesRequest.Builderto create a request.- Returns:
- Result of the ListCertificates operation returned by the service.
- See Also:
-
listCertificates
default ListCertificatesResponse listCertificates() throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmExceptionRetrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only
RSA_2048certificates. For more information, see Filters.By default, this action does not return certificates with a
CertificateKeyPairOriginofACME. To include ACME certificates, specifyACMEin theCertificateKeyPairOriginsfilter.- Returns:
- Result of the ListCertificates operation returned by the service.
- See Also:
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator() throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmExceptionThis is a variant of
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); for (software.amazon.awssdk.services.acm.model.ListCertificatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException This is a variant of
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); for (software.amazon.awssdk.services.acm.model.ListCertificatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation.- Parameters:
listCertificatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException This is a variant of
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); for (software.amazon.awssdk.services.acm.model.ListCertificatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)operation.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builderavoiding the need to create one manually viaListCertificatesRequest.builder()- Parameters:
listCertificatesRequest- AConsumerthat will call methods onListCertificatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForCertificate
default ListTagsForCertificateResponse listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest) throws InvalidArnException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
This action applies only to the
certificateresource type. For all other ACM resource types, use ListTagsForResource instead.- Parameters:
listTagsForCertificateRequest-- Returns:
- Result of the ListTagsForCertificate operation returned by the service.
- See Also:
-
listTagsForCertificate
default ListTagsForCertificateResponse listTagsForCertificate(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest) throws InvalidArnException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
This action applies only to the
certificateresource type. For all other ACM resource types, use ListTagsForResource instead.
This is a convenience which creates an instance of the
ListTagsForCertificateRequest.Builderavoiding the need to create one manually viaListTagsForCertificateRequest.builder()- Parameters:
listTagsForCertificateRequest- AConsumerthat will call methods onListTagsForCertificateRequest.Builderto create a request.- Returns:
- Result of the ListTagsForCertificate operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Lists the tags associated with an ACM resource.
Use this action for all ACM resource types except the
certificateresource type. For certificate resources, use ListTagsForCertificate instead.To add one or more tags, use the TagResource action. To remove one or more tags, use the UntagResource action.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Lists the tags associated with an ACM resource.
Use this action for all ACM resource types except the
certificateresource type. For certificate resources, use ListTagsForCertificate instead.To add one or more tags, use the TagResource action. To remove one or more tags, use the UntagResource action.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putAccountConfiguration
default PutAccountConfigurationResponse putAccountConfiguration(PutAccountConfigurationRequest putAccountConfigurationRequest) throws ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Adds or modifies account-level configurations in ACM.
The supported configuration option is
DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generatingEventBridgeevents. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.- Parameters:
putAccountConfigurationRequest-- Returns:
- Result of the PutAccountConfiguration operation returned by the service.
- See Also:
-
putAccountConfiguration
default PutAccountConfigurationResponse putAccountConfiguration(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest) throws ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Adds or modifies account-level configurations in ACM.
The supported configuration option is
DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generatingEventBridgeevents. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.
This is a convenience which creates an instance of the
PutAccountConfigurationRequest.Builderavoiding the need to create one manually viaPutAccountConfigurationRequest.builder()- Parameters:
putAccountConfigurationRequest- AConsumerthat will call methods onPutAccountConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutAccountConfiguration operation returned by the service.
- See Also:
-
removeTagsFromCertificate
default RemoveTagsFromCertificateResponse removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest) throws InvalidParameterException, TagPolicyException, InvalidArnException, InvalidTagException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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.
This action applies only to the
certificateresource type. For all other ACM resource types, use UntagResource instead.To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
- Parameters:
removeTagsFromCertificateRequest-- Returns:
- Result of the RemoveTagsFromCertificate operation returned by the service.
- See Also:
-
removeTagsFromCertificate
default RemoveTagsFromCertificateResponse removeTagsFromCertificate(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest) throws InvalidParameterException, TagPolicyException, InvalidArnException, InvalidTagException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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.
This action applies only to the
certificateresource type. For all other ACM resource types, use UntagResource instead.To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
This is a convenience which creates an instance of the
RemoveTagsFromCertificateRequest.Builderavoiding the need to create one manually viaRemoveTagsFromCertificateRequest.builder()- Parameters:
removeTagsFromCertificateRequest- AConsumerthat will call methods onRemoveTagsFromCertificateRequest.Builderto create a request.- Returns:
- Result of the RemoveTagsFromCertificate operation returned by the service.
- See Also:
-
renewCertificate
default RenewCertificateResponse renewCertificate(RenewCertificateRequest renewCertificateRequest) throws InvalidArnException, RequestInProgressException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Renews an eligible ACM certificate. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
- Parameters:
renewCertificateRequest-- Returns:
- Result of the RenewCertificate operation returned by the service.
- See Also:
-
renewCertificate
default RenewCertificateResponse renewCertificate(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest) throws InvalidArnException, RequestInProgressException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Renews an eligible ACM certificate. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
This is a convenience which creates an instance of the
RenewCertificateRequest.Builderavoiding the need to create one manually viaRenewCertificateRequest.builder()- Parameters:
renewCertificateRequest- AConsumerthat will call methods onRenewCertificateRequest.Builderto create a request.- Returns:
- Result of the RenewCertificate operation returned by the service.
- See Also:
-
requestCertificate
default RequestCertificateResponse requestCertificate(RequestCertificateRequest requestCertificateRequest) throws InvalidParameterException, TagPolicyException, TooManyTagsException, InvalidArnException, InvalidTagException, InvalidDomainValidationOptionsException, LimitExceededException, AwsServiceException, SdkClientException, AcmException Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the
DomainNameparameter. You can also specify additional FQDNs in theSubjectAlternativeNamesparameter.If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation.
ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).
After successful completion of the
RequestCertificateaction, there is a delay of several seconds before you can retrieve information about the new certificate.- Parameters:
requestCertificateRequest-- Returns:
- Result of the RequestCertificate operation returned by the service.
- See Also:
-
requestCertificate
default RequestCertificateResponse requestCertificate(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest) throws InvalidParameterException, TagPolicyException, TooManyTagsException, InvalidArnException, InvalidTagException, InvalidDomainValidationOptionsException, LimitExceededException, AwsServiceException, SdkClientException, AcmException Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the
DomainNameparameter. You can also specify additional FQDNs in theSubjectAlternativeNamesparameter.If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation.
ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).
After successful completion of the
RequestCertificateaction, there is a delay of several seconds before you can retrieve information about the new certificate.
This is a convenience which creates an instance of the
RequestCertificateRequest.Builderavoiding the need to create one manually viaRequestCertificateRequest.builder()- Parameters:
requestCertificateRequest- AConsumerthat will call methods onRequestCertificateRequest.Builderto create a request.- Returns:
- Result of the RequestCertificate operation returned by the service.
- See Also:
-
resendValidationEmail
default ResendValidationEmailResponse resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest) throws InvalidArnException, InvalidDomainValidationOptionsException, ValidationException, InvalidStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.
- Parameters:
resendValidationEmailRequest-- Returns:
- Result of the ResendValidationEmail operation returned by the service.
- See Also:
-
resendValidationEmail
default ResendValidationEmailResponse resendValidationEmail(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest) throws InvalidArnException, InvalidDomainValidationOptionsException, ValidationException, InvalidStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.
This is a convenience which creates an instance of the
ResendValidationEmailRequest.Builderavoiding the need to create one manually viaResendValidationEmailRequest.builder()- Parameters:
resendValidationEmailRequest- AConsumerthat will call methods onResendValidationEmailRequest.Builderto create a request.- Returns:
- Result of the ResendValidationEmail operation returned by the service.
- See Also:
-
revokeAcmeAccount
default RevokeAcmeAccountResponse revokeAcmeAccount(RevokeAcmeAccountRequest revokeAcmeAccountRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Revokes an ACME account, preventing it from requesting or revoking certificates. This operation is irreversible.
- Parameters:
revokeAcmeAccountRequest-- Returns:
- Result of the RevokeAcmeAccount operation returned by the service.
- See Also:
-
revokeAcmeAccount
default RevokeAcmeAccountResponse revokeAcmeAccount(Consumer<RevokeAcmeAccountRequest.Builder> revokeAcmeAccountRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Revokes an ACME account, preventing it from requesting or revoking certificates. This operation is irreversible.
This is a convenience which creates an instance of the
RevokeAcmeAccountRequest.Builderavoiding the need to create one manually viaRevokeAcmeAccountRequest.builder()- Parameters:
revokeAcmeAccountRequest- AConsumerthat will call methods onRevokeAcmeAccountRequest.Builderto create a request.- Returns:
- Result of the RevokeAcmeAccount operation returned by the service.
- See Also:
-
revokeAcmeExternalAccountBinding
default RevokeAcmeExternalAccountBindingResponse revokeAcmeExternalAccountBinding(RevokeAcmeExternalAccountBindingRequest revokeAcmeExternalAccountBindingRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Revokes an external account binding, preventing new ACME accounts from being registered using this binding. Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately.
- Parameters:
revokeAcmeExternalAccountBindingRequest-- Returns:
- Result of the RevokeAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
revokeAcmeExternalAccountBinding
default RevokeAcmeExternalAccountBindingResponse revokeAcmeExternalAccountBinding(Consumer<RevokeAcmeExternalAccountBindingRequest.Builder> revokeAcmeExternalAccountBindingRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Revokes an external account binding, preventing new ACME accounts from being registered using this binding. Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately.
This is a convenience which creates an instance of the
RevokeAcmeExternalAccountBindingRequest.Builderavoiding the need to create one manually viaRevokeAcmeExternalAccountBindingRequest.builder()- Parameters:
revokeAcmeExternalAccountBindingRequest- AConsumerthat will call methods onRevokeAcmeExternalAccountBindingRequest.Builderto create a request.- Returns:
- Result of the RevokeAcmeExternalAccountBinding operation returned by the service.
- See Also:
-
revokeCertificate
default RevokeCertificateResponse revokeCertificate(RevokeCertificateRequest revokeCertificateRequest) throws ResourceInUseException, InvalidArnException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Revokes a public ACM certificate. You can only revoke certificates that have been previously exported.
Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent.
- Parameters:
revokeCertificateRequest-- Returns:
- Result of the RevokeCertificate operation returned by the service.
- See Also:
-
revokeCertificate
default RevokeCertificateResponse revokeCertificate(Consumer<RevokeCertificateRequest.Builder> revokeCertificateRequest) throws ResourceInUseException, InvalidArnException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Revokes a public ACM certificate. You can only revoke certificates that have been previously exported.
Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent.
This is a convenience which creates an instance of the
RevokeCertificateRequest.Builderavoiding the need to create one manually viaRevokeCertificateRequest.builder()- Parameters:
revokeCertificateRequest- AConsumerthat will call methods onRevokeCertificateRequest.Builderto create a request.- Returns:
- Result of the RevokeCertificate operation returned by the service.
- See Also:
-
searchCertificates
default SearchCertificatesResponse searchCertificates(SearchCertificatesRequest searchCertificatesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.
- Parameters:
searchCertificatesRequest-- Returns:
- Result of the SearchCertificates operation returned by the service.
- See Also:
-
searchCertificates
default SearchCertificatesResponse searchCertificates(Consumer<SearchCertificatesRequest.Builder> searchCertificatesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.
This is a convenience which creates an instance of the
SearchCertificatesRequest.Builderavoiding the need to create one manually viaSearchCertificatesRequest.builder()- Parameters:
searchCertificatesRequest- AConsumerthat will call methods onSearchCertificatesRequest.Builderto create a request.- Returns:
- Result of the SearchCertificates operation returned by the service.
- See Also:
-
searchCertificatesPaginator
default SearchCertificatesIterable searchCertificatesPaginator(SearchCertificatesRequest searchCertificatesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
searchCertificates(software.amazon.awssdk.services.acm.model.SearchCertificatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.SearchCertificatesIterable responses = client.searchCertificatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.SearchCertificatesIterable responses = client .searchCertificatesPaginator(request); for (software.amazon.awssdk.services.acm.model.SearchCertificatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.SearchCertificatesIterable responses = client.searchCertificatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchCertificates(software.amazon.awssdk.services.acm.model.SearchCertificatesRequest)operation.- Parameters:
searchCertificatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchCertificatesPaginator
default SearchCertificatesIterable searchCertificatesPaginator(Consumer<SearchCertificatesRequest.Builder> searchCertificatesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, AcmException This is a variant of
searchCertificates(software.amazon.awssdk.services.acm.model.SearchCertificatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.acm.paginators.SearchCertificatesIterable responses = client.searchCertificatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.acm.paginators.SearchCertificatesIterable responses = client .searchCertificatesPaginator(request); for (software.amazon.awssdk.services.acm.model.SearchCertificatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.acm.paginators.SearchCertificatesIterable responses = client.searchCertificatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchCertificates(software.amazon.awssdk.services.acm.model.SearchCertificatesRequest)operation.
This is a convenience which creates an instance of the
SearchCertificatesRequest.Builderavoiding the need to create one manually viaSearchCertificatesRequest.builder()- Parameters:
searchCertificatesRequest- AConsumerthat will call methods onSearchCertificatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceQuotaExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Adds one or more tags to an ACM resource. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a
keyand an optionalvalue.Use this action for all ACM resource types except the
certificateresource type. For certificate resources, use AddTagsToCertificate instead.To remove one or more tags, use the UntagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceQuotaExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Adds one or more tags to an ACM resource. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a
keyand an optionalvalue.Use this action for all ACM resource types except the
certificateresource type. For certificate resources, use AddTagsToCertificate instead.To remove one or more tags, use the UntagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Removes one or more tags from an ACM resource.
Use this action for all ACM resource types except the
certificateresource type. For certificate resources, use RemoveTagsFromCertificate instead.To add one or more tags, use the TagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Removes one or more tags from an ACM resource.
Use this action for all ACM resource types except the
certificateresource type. For certificate resources, use RemoveTagsFromCertificate instead.To add one or more tags, use the TagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAcmeDomainValidation
default UpdateAcmeDomainValidationResponse updateAcmeDomainValidation(UpdateAcmeDomainValidationRequest updateAcmeDomainValidationRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Updates the prevalidation configuration of an existing domain validation.
- Parameters:
updateAcmeDomainValidationRequest-- Returns:
- Result of the UpdateAcmeDomainValidation operation returned by the service.
- See Also:
-
updateAcmeDomainValidation
default UpdateAcmeDomainValidationResponse updateAcmeDomainValidation(Consumer<UpdateAcmeDomainValidationRequest.Builder> updateAcmeDomainValidationRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Updates the prevalidation configuration of an existing domain validation.
This is a convenience which creates an instance of the
UpdateAcmeDomainValidationRequest.Builderavoiding the need to create one manually viaUpdateAcmeDomainValidationRequest.builder()- Parameters:
updateAcmeDomainValidationRequest- AConsumerthat will call methods onUpdateAcmeDomainValidationRequest.Builderto create a request.- Returns:
- Result of the UpdateAcmeDomainValidation operation returned by the service.
- See Also:
-
updateAcmeEndpoint
default UpdateAcmeEndpointResponse updateAcmeEndpoint(UpdateAcmeEndpointRequest updateAcmeEndpointRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Updates the configuration of an existing ACME endpoint. You can change the authorization behavior, contact requirement, or certificate authority settings.
- Parameters:
updateAcmeEndpointRequest-- Returns:
- Result of the UpdateAcmeEndpoint operation returned by the service.
- See Also:
-
updateAcmeEndpoint
default UpdateAcmeEndpointResponse updateAcmeEndpoint(Consumer<UpdateAcmeEndpointRequest.Builder> updateAcmeEndpointRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, AcmException Updates the configuration of an existing ACME endpoint. You can change the authorization behavior, contact requirement, or certificate authority settings.
This is a convenience which creates an instance of the
UpdateAcmeEndpointRequest.Builderavoiding the need to create one manually viaUpdateAcmeEndpointRequest.builder()- Parameters:
updateAcmeEndpointRequest- AConsumerthat will call methods onUpdateAcmeEndpointRequest.Builderto create a request.- Returns:
- Result of the UpdateAcmeEndpoint operation returned by the service.
- See Also:
-
updateCertificateOptions
default UpdateCertificateOptionsResponse updateCertificateOptions(UpdateCertificateOptionsRequest updateCertificateOptionsRequest) throws InvalidArnException, LimitExceededException, ValidationException, InvalidStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Updates a certificate. You can use this function to specify whether to export your certificate. Certificate transparency logging opt-out is no longer available. For more information, see Certificate Transparency Logging and Certificate Manager Exportable Managed Certificates.
- Parameters:
updateCertificateOptionsRequest-- Returns:
- Result of the UpdateCertificateOptions operation returned by the service.
- See Also:
-
updateCertificateOptions
default UpdateCertificateOptionsResponse updateCertificateOptions(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest) throws InvalidArnException, LimitExceededException, ValidationException, InvalidStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmException Updates a certificate. You can use this function to specify whether to export your certificate. Certificate transparency logging opt-out is no longer available. For more information, see Certificate Transparency Logging and Certificate Manager Exportable Managed Certificates.
This is a convenience which creates an instance of the
UpdateCertificateOptionsRequest.Builderavoiding the need to create one manually viaUpdateCertificateOptionsRequest.builder()- Parameters:
updateCertificateOptionsRequest- AConsumerthat will call methods onUpdateCertificateOptionsRequest.Builderto create a request.- Returns:
- Result of the UpdateCertificateOptions operation returned by the service.
- See Also:
-
waiter
-
create
Create aAcmClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aAcmClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-