acmpca: AWS Certificate Manager Private Certificate Authority

Description Usage Arguments Service syntax Operations Examples

View source: R/acmpca_service.R

Description

This is the ACM Private CA API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.

The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

Each ACM Private CA API action has a throttling limit which determines the number of times the action can be called per second. For more information, see API Rate Limits in ACM Private CA in the ACM Private CA user guide.

Usage

1
acmpca(config = list())

Arguments

config

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

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- acmpca(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_certificate_authority Creates a root or subordinate private certificate authority (CA)
create_certificate_authority_audit_report Creates an audit report that lists every time that your CA private key is used
create_permission Assigns permissions from a private CA to a designated AWS service
delete_certificate_authority Deletes a private certificate authority (CA)
delete_permission Revokes permissions that a private CA assigned to a designated AWS service
describe_certificate_authority Lists information about your private certificate authority (CA)
describe_certificate_authority_audit_report Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action
get_certificate Retrieves a certificate from your private CA
get_certificate_authority_certificate Retrieves the certificate and certificate chain for your private certificate authority (CA)
get_certificate_authority_csr Retrieves the certificate signing request (CSR) for your private certificate authority (CA)
import_certificate_authority_certificate Imports a signed private CA certificate into ACM Private CA
issue_certificate Uses your private certificate authority (CA) to issue a client certificate
list_certificate_authorities Lists the private certificate authorities that you created by using the CreateCertificateAuthority action
list_permissions Lists all the permissions, if any, that have been assigned by a private CA
list_tags Lists the tags, if any, that are associated with your 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 ACM 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

1
2
3
4
svc <- acmpca()
svc$create_certificate_authority(
  Foo = 123
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.