Client

acmpca

R Documentation

AWS Certificate Manager Private Certificate Authority¶

Description¶

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.

The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

Usage¶

acmpca(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- acmpca(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_certificate_authority: Creates a root or subordinate private certificate authority (CA); Creates an audit report that lists every time that your CA private key is used
create_permission: Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm
delete_certificate_authority: Deletes a private certificate authority (CA)
delete_permission: Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm
delete_policy: Deletes the resource-based policy attached to a private CA
describe_certificate_authority: Lists information about your private certificate authority (CA) or one that has been shared with you; Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action
get_certificate: Retrieves a certificate from your private CA or one that has been shared with you
get_certificate_authority_certificate: Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you
get_certificate_authority_csr: Retrieves the certificate signing request (CSR) for your private certificate authority (CA)
get_policy: Retrieves the resource-based policy attached to a private CA; Imports a signed private CA certificate into Amazon Web Services Private CA
issue_certificate: Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate
list_certificate_authorities: Lists the private certificate authorities that you created by using the CreateCertificateAuthority action
list_permissions: List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm
list_tags: Lists the tags, if any, that are associated with your private CA or one that has been shared with you
put_policy: Attaches a resource-based policy to a private CA
restore_certificate_authority: Restores a certificate authority (CA) that is in the DELETED state
revoke_certificate: Revokes a certificate that was issued inside Amazon Web Services Private CA
tag_certificate_authority: Adds one or more tags to your private CA
untag_certificate_authority: Remove one or more tags from your private CA
update_certificate_authority: Updates the status or configuration of a private certificate authority (CA)

Examples¶

## Not run: 
svc <- acmpca()
svc$create_certificate_authority(
  Foo = 123
)

## End(Not run)