Class: Aws::ACMPCA::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb

Overview

An API client for ACMPCA. To construct a client, you need to configure a :region and :credentials.

client = Aws::ACMPCA::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



334
335
336
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#create_certificate_authority(params = {}) ⇒ Types::CreateCertificateAuthorityResponse

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.

Examples:

Request syntax with placeholder values


resp = client.create_certificate_authority({
  certificate_authority_configuration: { # required
    key_algorithm: "RSA_2048", # required, accepts RSA_2048, RSA_4096, EC_prime256v1, EC_secp384r1
    signing_algorithm: "SHA256WITHECDSA", # required, accepts SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA, SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA
    subject: { # required
      country: "CountryCodeString",
      organization: "String64",
      organizational_unit: "String64",
      distinguished_name_qualifier: "ASN1PrintableString64",
      state: "String128",
      common_name: "String64",
      serial_number: "ASN1PrintableString64",
      locality: "String128",
      title: "String64",
      surname: "String40",
      given_name: "String16",
      initials: "String5",
      pseudonym: "String128",
      generation_qualifier: "String3",
    },
  },
  revocation_configuration: {
    crl_configuration: {
      enabled: false, # required
      expiration_in_days: 1,
      custom_cname: "String253",
      s3_bucket_name: "String3To255",
    },
  },
  certificate_authority_type: "ROOT", # required, accepts ROOT, SUBORDINATE
  idempotency_token: "IdempotencyToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.certificate_authority_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_configuration (required, Types::CertificateAuthorityConfiguration)

    Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

  • :revocation_configuration (Types::RevocationConfiguration)

    Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.

  • :certificate_authority_type (required, String)

    The type of the certificate authority.

  • :idempotency_token (String)

    Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. For a given token, ACM Private CA creates exactly one CA. If you issue a subsequent call using the same token, ACM Private CA returns the ARN of the existing CA and takes no further action. If you change the idempotency token across multiple calls, ACM Private CA creates a unique CA for each unique token.

  • :tags (Array<Types::Tag>)

    Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.

Returns:

See Also:



458
459
460
461
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 458

def create_certificate_authority(params = {}, options = {})
  req = build_request(:create_certificate_authority, params)
  req.send_request(options)
end

#create_certificate_authority_audit_report(params = {}) ⇒ Types::CreateCertificateAuthorityAuditReportResponse

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

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.

Examples:

Request syntax with placeholder values


resp = client.create_certificate_authority_audit_report({
  certificate_authority_arn: "Arn", # required
  s3_bucket_name: "S3BucketName", # required
  audit_report_response_format: "JSON", # required, accepts JSON, CSV
})

Response structure


resp.audit_report_id #=> String
resp.s3_key #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • :s3_bucket_name (required, String)

    The name of the S3 bucket that will contain the audit report.

  • :audit_report_response_format (required, String)

    The format in which to create the report. This can be either JSON or CSV.

Returns:

See Also:



522
523
524
525
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 522

def create_certificate_authority_audit_report(params = {}, options = {})
  req = build_request(:create_certificate_authority_audit_report, params)
  req.send_request(options)
end

#create_permission(params = {}) ⇒ Struct

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

Examples:

Request syntax with placeholder values


resp = client.create_permission({
  certificate_authority_arn: "Arn", # required
  principal: "Principal", # required
  source_account: "AccountId",
  actions: ["IssueCertificate"], # required, accepts IssueCertificate, GetCertificate, ListPermissions
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • :principal (required, String)

    The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

  • :source_account (String)

    The ID of the calling account.

  • :actions (required, Array<String>)

    The actions that the specified AWS service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



595
596
597
598
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 595

def create_permission(params = {}, options = {})
  req = build_request(:create_permission, params)
  req.send_request(options)
end

#delete_certificate_authority(params = {}) ⇒ Struct

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

Examples:

Request syntax with placeholder values


resp = client.delete_certificate_authority({
  certificate_authority_arn: "Arn", # required
  permanent_deletion_time_in_days: 1,
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • :permanent_deletion_time_in_days (Integer)

    The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



667
668
669
670
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 667

def delete_certificate_authority(params = {}, options = {})
  req = build_request(:delete_certificate_authority, params)
  req.send_request(options)
end

#delete_permission(params = {}) ⇒ Struct

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

Examples:

Request syntax with placeholder values


resp = client.delete_permission({
  certificate_authority_arn: "Arn", # required
  principal: "Principal", # required
  source_account: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • :principal (required, String)

    The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

  • :source_account (String)

    The AWS account that calls this action.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



739
740
741
742
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 739

def delete_permission(params = {}, options = {})
  req = build_request(:delete_permission, params)
  req.send_request(options)
end

#delete_policy(params = {}) ⇒ Struct

Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

If you delete a policy that was applied through AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

The current policy can be shown with GetPolicy and updated with PutPolicy.

About Policies

  • A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

  • A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

  • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

  • Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Using AWS Resource Access Manager (RAM) with ACM Private CA.

Examples:

Request syntax with placeholder values


resp = client.delete_policy({
  resource_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



809
810
811
812
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 809

def delete_policy(params = {}, options = {})
  req = build_request(:delete_policy, params)
  req.send_request(options)
end

#describe_certificate_authority(params = {}) ⇒ Types::DescribeCertificateAuthorityResponse

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

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

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

  • ACTIVE - Your private CA is active.

  • DISABLED - Your private CA has been disabled.

  • EXPIRED - Your private CA certificate has expired.

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

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

Examples:

Request syntax with placeholder values


resp = client.describe_certificate_authority({
  certificate_authority_arn: "Arn", # required
})

Response structure


resp.certificate_authority.arn #=> String
resp.certificate_authority. #=> String
resp.certificate_authority.created_at #=> Time
resp.certificate_authority.last_state_change_at #=> Time
resp.certificate_authority.type #=> String, one of "ROOT", "SUBORDINATE"
resp.certificate_authority.serial #=> String
resp.certificate_authority.status #=> String, one of "CREATING", "PENDING_CERTIFICATE", "ACTIVE", "DELETED", "DISABLED", "EXPIRED", "FAILED"
resp.certificate_authority.not_before #=> Time
resp.certificate_authority.not_after #=> Time
resp.certificate_authority.failure_reason #=> String, one of "REQUEST_TIMED_OUT", "UNSUPPORTED_ALGORITHM", "OTHER"
resp.certificate_authority.certificate_authority_configuration.key_algorithm #=> String, one of "RSA_2048", "RSA_4096", "EC_prime256v1", "EC_secp384r1"
resp.certificate_authority.certificate_authority_configuration.signing_algorithm #=> String, one of "SHA256WITHECDSA", "SHA384WITHECDSA", "SHA512WITHECDSA", "SHA256WITHRSA", "SHA384WITHRSA", "SHA512WITHRSA"
resp.certificate_authority.certificate_authority_configuration.subject.country #=> String
resp.certificate_authority.certificate_authority_configuration.subject.organization #=> String
resp.certificate_authority.certificate_authority_configuration.subject.organizational_unit #=> String
resp.certificate_authority.certificate_authority_configuration.subject.distinguished_name_qualifier #=> String
resp.certificate_authority.certificate_authority_configuration.subject.state #=> String
resp.certificate_authority.certificate_authority_configuration.subject.common_name #=> String
resp.certificate_authority.certificate_authority_configuration.subject.serial_number #=> String
resp.certificate_authority.certificate_authority_configuration.subject.locality #=> String
resp.certificate_authority.certificate_authority_configuration.subject.title #=> String
resp.certificate_authority.certificate_authority_configuration.subject.surname #=> String
resp.certificate_authority.certificate_authority_configuration.subject.given_name #=> String
resp.certificate_authority.certificate_authority_configuration.subject.initials #=> String
resp.certificate_authority.certificate_authority_configuration.subject.pseudonym #=> String
resp.certificate_authority.certificate_authority_configuration.subject.generation_qualifier #=> String
resp.certificate_authority.revocation_configuration.crl_configuration.enabled #=> Boolean
resp.certificate_authority.revocation_configuration.crl_configuration.expiration_in_days #=> Integer
resp.certificate_authority.revocation_configuration.crl_configuration.custom_cname #=> String
resp.certificate_authority.revocation_configuration.crl_configuration.s3_bucket_name #=> String
resp.certificate_authority.restorable_until #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

Returns:

See Also:



900
901
902
903
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 900

def describe_certificate_authority(params = {}, options = {})
  req = build_request(:describe_certificate_authority, params)
  req.send_request(options)
end

#describe_certificate_authority_audit_report(params = {}) ⇒ Types::DescribeCertificateAuthorityAuditReportResponse

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • audit_report_created

Examples:

Request syntax with placeholder values


resp = client.describe_certificate_authority_audit_report({
  certificate_authority_arn: "Arn", # required
  audit_report_id: "AuditReportId", # required
})

Response structure


resp.audit_report_status #=> String, one of "CREATING", "SUCCESS", "FAILED"
resp.s3_bucket_name #=> String
resp.s3_key #=> String
resp.created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) of the private CA. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • :audit_report_id (required, String)

    The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

Returns:

See Also:



962
963
964
965
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 962

def describe_certificate_authority_audit_report(params = {}, options = {})
  req = build_request(:describe_certificate_authority_audit_report, params)
  req.send_request(options)
end

#get_certificate(params = {}) ⇒ Types::GetCertificateResponse

Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • certificate_issued

Examples:

Request syntax with placeholder values


resp = client.get_certificate({
  certificate_authority_arn: "Arn", # required
  certificate_arn: "Arn", # required
})

Response structure


resp.certificate #=> String
resp.certificate_chain #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • :certificate_arn (required, String)

    The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245

Returns:

See Also:



1026
1027
1028
1029
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1026

def get_certificate(params = {}, options = {})
  req = build_request(:get_certificate, params)
  req.send_request(options)
end

#get_certificate_authority_certificate(params = {}) ⇒ Types::GetCertificateAuthorityCertificateResponse

Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

Examples:

Request syntax with placeholder values


resp = client.get_certificate_authority_certificate({
  certificate_authority_arn: "Arn", # required
})

Response structure


resp.certificate #=> String
resp.certificate_chain #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) of your private CA. This is of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

Returns:

See Also:



1064
1065
1066
1067
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1064

def get_certificate_authority_certificate(params = {}, options = {})
  req = build_request(:get_certificate_authority_certificate, params)
  req.send_request(options)
end

#get_certificate_authority_csr(params = {}) ⇒ Types::GetCertificateAuthorityCsrResponse

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

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • certificate_authority_csr_created

Examples:

Request syntax with placeholder values


resp = client.get_certificate_authority_csr({
  certificate_authority_arn: "Arn", # required
})

Response structure


resp.csr #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Returns:

See Also:



1116
1117
1118
1119
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1116

def get_certificate_authority_csr(params = {}, options = {})
  req = build_request(:get_certificate_authority_csr, params)
  req.send_request(options)
end

#get_policy(params = {}) ⇒ Types::GetPolicyResponse

Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

  • A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

  • A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

  • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

  • Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Using AWS Resource Access Manager (RAM) with ACM Private CA.

Examples:

Request syntax with placeholder values


resp = client.get_policy({
  resource_arn: "Arn", # required
})

Response structure


resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

Returns:

See Also:



1179
1180
1181
1182
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1179

def get_policy(params = {}, options = {})
  req = build_request(:get_policy, params)
  req.send_request(options)
end

#import_certificate_authority_certificate(params = {}) ⇒ Struct

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

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

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

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

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

The following requirements apply when you import a CA certificate.

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

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

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

  • Your ACM Private CA-hosted or on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.

  • The chain must be PEM-encoded.

  • The maximum allowed size of a certificate is 32 KB.

  • The maximum allowed size of a certificate chain is 2 MB.

Enforcement of Critical Constraints

ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

  • Basic constraints (must be marked critical)

  • Subject alternative names

  • Key usage

  • Extended key usage

  • Authority key identifier

  • Subject key identifier

  • Issuer alternative name

  • Subject directory attributes

  • Subject information access

  • Certificate policies

  • Policy mappings

  • Inhibit anyPolicy

ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

  • Name constraints

  • Policy constraints

  • CRL distribution points

  • Authority information access

  • Freshest CRL

  • Any other extension

Examples:

Request syntax with placeholder values


resp = client.import_certificate_authority_certificate({
  certificate_authority_arn: "Arn", # required
  certificate: "data", # required
  certificate_chain: "data",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • :certificate (required, String, StringIO, File)

    The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.

  • :certificate_chain (String, StringIO, File)

    A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

    This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1313
1314
1315
1316
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1313

def import_certificate_authority_certificate(params = {}, options = {})
  req = build_request(:import_certificate_authority_certificate, params)
  req.send_request(options)
end

#issue_certificate(params = {}) ⇒ Types::IssueCertificateResponse

Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.

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

Examples:

Request syntax with placeholder values


resp = client.issue_certificate({
  certificate_authority_arn: "Arn", # required
  csr: "data", # required
  signing_algorithm: "SHA256WITHECDSA", # required, accepts SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA, SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA
  template_arn: "Arn",
  validity: { # required
    value: 1, # required
    type: "END_DATE", # required, accepts END_DATE, ABSOLUTE, DAYS, MONTHS, YEARS
  },
  idempotency_token: "IdempotencyToken",
})

Response structure


resp.certificate_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • :csr (required, String, StringIO, File)

    The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

    openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

    If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

    openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

    Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

  • :signing_algorithm (required, String)

    The name of the algorithm that will be used to sign the certificate to be issued.

    This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.

  • :template_arn (String)

    Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

    Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

    The following service-owned TemplateArn values are supported by ACM Private CA:

    • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

    • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

    • arn:aws:acm-pca:::template/EndEntityCertificate/V1

    • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

    • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

    • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

    • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

    • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

    • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

    • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

    • arn:aws:acm-pca:::template/RootCACertificate/V1

    • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

    • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

    • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

    • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

    For more information, see Using Templates.

  • :validity (required, Types::Validity)

    Information describing the validity period of the certificate.

    When issuing a certificate, ACM Private CA sets the "Not Before" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.

    The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.

  • :idempotency_token (String)

    Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Returns:

See Also:



1468
1469
1470
1471
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1468

def issue_certificate(params = {}, options = {})
  req = build_request(:issue_certificate, params)
  req.send_request(options)
end

#list_certificate_authorities(params = {}) ⇒ Types::ListCertificateAuthoritiesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_certificate_authorities({
  next_token: "NextToken",
  max_results: 1,
  resource_owner: "SELF", # accepts SELF, OTHER_ACCOUNTS
})

Response structure


resp.certificate_authorities #=> Array
resp.certificate_authorities[0].arn #=> String
resp.certificate_authorities[0]. #=> String
resp.certificate_authorities[0].created_at #=> Time
resp.certificate_authorities[0].last_state_change_at #=> Time
resp.certificate_authorities[0].type #=> String, one of "ROOT", "SUBORDINATE"
resp.certificate_authorities[0].serial #=> String
resp.certificate_authorities[0].status #=> String, one of "CREATING", "PENDING_CERTIFICATE", "ACTIVE", "DELETED", "DISABLED", "EXPIRED", "FAILED"
resp.certificate_authorities[0].not_before #=> Time
resp.certificate_authorities[0].not_after #=> Time
resp.certificate_authorities[0].failure_reason #=> String, one of "REQUEST_TIMED_OUT", "UNSUPPORTED_ALGORITHM", "OTHER"
resp.certificate_authorities[0].certificate_authority_configuration.key_algorithm #=> String, one of "RSA_2048", "RSA_4096", "EC_prime256v1", "EC_secp384r1"
resp.certificate_authorities[0].certificate_authority_configuration.signing_algorithm #=> String, one of "SHA256WITHECDSA", "SHA384WITHECDSA", "SHA512WITHECDSA", "SHA256WITHRSA", "SHA384WITHRSA", "SHA512WITHRSA"
resp.certificate_authorities[0].certificate_authority_configuration.subject.country #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.organization #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.organizational_unit #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.distinguished_name_qualifier #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.state #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.common_name #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.serial_number #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.locality #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.title #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.surname #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.given_name #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.initials #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.pseudonym #=> String
resp.certificate_authorities[0].certificate_authority_configuration.subject.generation_qualifier #=> String
resp.certificate_authorities[0].revocation_configuration.crl_configuration.enabled #=> Boolean
resp.certificate_authorities[0].revocation_configuration.crl_configuration.expiration_in_days #=> Integer
resp.certificate_authorities[0].revocation_configuration.crl_configuration.custom_cname #=> String
resp.certificate_authorities[0].revocation_configuration.crl_configuration.s3_bucket_name #=> String
resp.certificate_authorities[0].restorable_until #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

  • :max_results (Integer)

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

  • :resource_owner (String)

    Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.

Returns:

See Also:



1552
1553
1554
1555
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1552

def list_certificate_authorities(params = {}, options = {})
  req = build_request(:list_certificate_authorities, params)
  req.send_request(options)
end

#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse

List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_permissions({
  certificate_authority_arn: "Arn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.permissions #=> Array
resp.permissions[0].certificate_authority_arn #=> String
resp.permissions[0].created_at #=> Time
resp.permissions[0].principal #=> String
resp.permissions[0]. #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String, one of "IssueCertificate", "GetCertificate", "ListPermissions"
resp.permissions[0].policy #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.

  • :next_token (String)

    When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

  • :max_results (Integer)

    When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Returns:

See Also:



1643
1644
1645
1646
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1643

def list_permissions(params = {}, options = {})
  req = build_request(:list_permissions, params)
  req.send_request(options)
end

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  certificate_authority_arn: "Arn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • :next_token (String)

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

  • :max_results (Integer)

    Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Returns:

See Also:



1709
1710
1711
1712
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1709

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
end

#put_policy(params = {}) ⇒ Struct

Attaches a resource-based policy to a private CA.

A policy can also be applied by sharing a private CA through AWS Resource Access Manager (RAM).

The policy can be displayed with GetPolicy and removed with DeletePolicy.

About Policies

  • A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

  • A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

  • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

  • Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Using AWS Resource Access Manager (RAM) with ACM Private CA.

Examples:

Request syntax with placeholder values


resp = client.put_policy({
  resource_arn: "Arn", # required
  policy: "AWSPolicy", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.

  • :policy (required, String)

    The path and filename of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1787
1788
1789
1790
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1787

def put_policy(params = {}, options = {})
  req = build_request(:put_policy, params)
  req.send_request(options)
end

#restore_certificate_authority(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.restore_certificate_authority({
  certificate_authority_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1841
1842
1843
1844
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1841

def restore_certificate_authority(params = {}, options = {})
  req = build_request(:restore_certificate_authority, params)
  req.send_request(options)
end

#revoke_certificate(params = {}) ⇒ Struct

Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.

ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

You cannot revoke a root CA self-signed certificate.

Examples:

Request syntax with placeholder values


resp = client.revoke_certificate({
  certificate_authority_arn: "Arn", # required
  certificate_serial: "String128", # required
  revocation_reason: "UNSPECIFIED", # required, accepts UNSPECIFIED, KEY_COMPROMISE, CERTIFICATE_AUTHORITY_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, PRIVILEGE_WITHDRAWN, A_A_COMPROMISE
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • :certificate_serial (required, String)

    Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.

    openssl x509 -in file_path -text -noout

    You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

  • :revocation_reason (required, String)

    Specifies why you revoked the certificate.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1921
1922
1923
1924
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1921

def revoke_certificate(params = {}, options = {})
  req = build_request(:revoke_certificate, params)
  req.send_request(options)
end

#tag_certificate_authority(params = {}) ⇒ Struct

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.

Examples:

Request syntax with placeholder values


resp = client.tag_certificate_authority({
  certificate_authority_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • :tags (required, Array<Types::Tag>)

    List of tags to be associated with the CA.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1974
1975
1976
1977
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 1974

def tag_certificate_authority(params = {}, options = {})
  req = build_request(:tag_certificate_authority, params)
  req.send_request(options)
end

#untag_certificate_authority(params = {}) ⇒ Struct

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.

Examples:

Request syntax with placeholder values


resp = client.untag_certificate_authority({
  certificate_authority_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • :tags (required, Array<Types::Tag>)

    List of tags to be removed from the CA.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2024
2025
2026
2027
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 2024

def untag_certificate_authority(params = {}, options = {})
  req = build_request(:untag_certificate_authority, params)
  req.send_request(options)
end

#update_certificate_authority(params = {}) ⇒ Struct

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.

Examples:

Request syntax with placeholder values


resp = client.update_certificate_authority({
  certificate_authority_arn: "Arn", # required
  revocation_configuration: {
    crl_configuration: {
      enabled: false, # required
      expiration_in_days: 1,
      custom_cname: "String253",
      s3_bucket_name: "String3To255",
    },
  },
  status: "CREATING", # accepts CREATING, PENDING_CERTIFICATE, ACTIVE, DELETED, DISABLED, EXPIRED, FAILED
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String)

    Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • :revocation_configuration (Types::RevocationConfiguration)

    Revocation information for your private CA.

  • :status (String)

    Status of your private CA.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2080
2081
2082
2083
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 2080

def update_certificate_authority(params = {}, options = {})
  req = build_request(:update_certificate_authority, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
audit_report_created #describe_certificate_authority_audit_report 3 60
certificate_authority_csr_created #get_certificate_authority_csr 3 60
certificate_issued #get_certificate 3 60

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {})

    ({})

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.



2192
2193
2194
2195
2196
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/client.rb', line 2192

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end