ex_aws_acm

v1.0.0

ex_aws_acm v1.0.0 ExAws.ACM

Operations for AWS Certificate Manager.

Basic Usage 

ExAws.ACM.request_certificate("helloworld.example.com", validation_method: "DNS") |> ExAws.request!()

Link to this section Summary

Types

certificate_arn()
certificate_options()
domain_validation_option()
filter()
import_certificate_opts()
list_certificates_opts()
request_certificate_opts()
tag()

Functions

add_tags_to_certificate(certificate_arn, tags)

Adds one or more tags to an ACM certificate.

delete_certificate(certificate_arn)

Deletes a certificate and its associated private key.

describe_certificate(certificate_arn)

Returns detailed metadata about the specified ACM certificate.

export_certificate(certificate_arn, passphrase)

Exports a private certificate issued by a private certificate authority (CA).

get_certificate(certificate_arn)

Retrieves an Amazon-issued certificate and its certificate chain.

import_certificate(certificate, private_key, opts \\ [])

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM.

list_certificates(opts \\ [])

Retrieves a list of certificate ARNs and domain names.

list_tags_for_certificate(certificate_arn)

Lists the tags that have been applied to the ACM certificate.

remove_tags_from_certificate(certificate_arn, tags)

Remove one or more tags from an ACM certificate.

renew_certificate(certificate_arn)

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation.

request_certificate(domain_name, opts \\ [])

Requests an ACM certificate for use with other AWS services.

resend_validation_email(certificate_arn, domain, validation_domain)

Resends the email that requests domain ownership validation.

update_certificate_options(certificate_arn, options)

Updates a certificate.

Link to this section Types

Link to this type

certificate_arn()

Specs

certificate_arn() :: String.t()
Link to this type

certificate_options()

Specs

certificate_options() :: [
  {:certificate_transparency_logging_preference, String.t()}
]
Link to this type

domain_validation_option()

Specs

domain_validation_option() :: %{
  domain_name: String.t(),
  validation_domain: String.t()
}
Link to this type

filter()

Specs

filter() :: %{
  extended_key_usage: [String.t()],
  key_types: [String.t()],
  key_usage: [String.t()]
}
Link to this type

import_certificate_opts()

Specs

import_certificate_opts() :: [
  certificate_arn: certificate_arn(),
  certificate_chain: binary(),
  tags: [tag()]
]
Link to this type

list_certificates_opts()

Specs

list_certificates_opts() :: [
  certificate_statuses: String.t(),
  includes: filter(),
  max_items: pos_integer(),
  next_token: String.t()
]
Link to this type

request_certificate_opts()

Specs

request_certificate_opts() :: [
  certificate_authority_arn: String.t(),
  domain_validation_options: domain_validation_option(),
  idempotency_token: String.t(),
  options: certificate_options(),
  subject_alternative_names: [String.t()],
  tags: [tag()],
  validation_method: String.t()
]
Link to this type

tag()

Specs

tag() :: %{key: String.t(), value: String.t()}

Link to this section Functions

Link to this function

add_tags_to_certificate(certificate_arn, tags)

Specs

add_tags_to_certificate(certificate_arn(), [tag()]) :: ExAws.Operation.JSON.t()

Adds one or more tags to an ACM certificate.

Link to this function

delete_certificate(certificate_arn)

Specs

delete_certificate(certificate_arn()) :: ExAws.Operation.JSON.t()

Deletes a certificate and its associated private key.

Link to this function

describe_certificate(certificate_arn)

Specs

describe_certificate(certificate_arn()) :: ExAws.Operation.JSON.t()

Returns detailed metadata about the specified ACM certificate.

Link to this function

export_certificate(certificate_arn, passphrase)

Specs

export_certificate(certificate_arn(), binary()) :: ExAws.Operation.JSON.t()

Exports a private certificate issued by a private certificate authority (CA).

Link to this function

get_certificate(certificate_arn)

Specs

get_certificate(certificate_arn()) :: ExAws.Operation.JSON.t()

Retrieves an Amazon-issued certificate and its certificate chain.

Link to this function

import_certificate(certificate, private_key, opts \\ [])

Specs

import_certificate(binary(), binary(), import_certificate_opts()) ::
  ExAws.Operation.JSON.t()

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM.

Link to this function

list_certificates(opts \\ [])

Specs

list_certificates(list_certificates_opts()) :: ExAws.Operation.JSON.t()

Retrieves a list of certificate ARNs and domain names.

Link to this function

list_tags_for_certificate(certificate_arn)

Specs

list_tags_for_certificate(certificate_arn()) :: ExAws.Operation.JSON.t()

Lists the tags that have been applied to the ACM certificate.

Link to this function

remove_tags_from_certificate(certificate_arn, tags)

Specs

remove_tags_from_certificate(certificate_arn(), [tag()]) ::
  ExAws.Operation.JSON.t()

Remove one or more tags from an ACM certificate.

Link to this function

renew_certificate(certificate_arn)

Specs

renew_certificate(String.t()) :: ExAws.Operation.JSON.t()

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation.

Link to this function

request_certificate(domain_name, opts \\ [])

Specs

request_certificate(certificate_arn(), request_certificate_opts()) ::
  ExAws.Operation.JSON.t()

Requests an ACM certificate for use with other AWS services.

Link to this function

resend_validation_email(certificate_arn, domain, validation_domain)

Specs

resend_validation_email(certificate_arn(), String.t(), String.t()) ::
  ExAws.Operation.JSON.t()

Resends the email that requests domain ownership validation.

Link to this function

update_certificate_options(certificate_arn, options)

Specs

update_certificate_options(certificate_arn(), certificate_options()) ::
  ExAws.Operation.JSON.t()

Updates a certificate.