CreatePermission - AWS Private Certificate Authority (original) (raw)

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

Request Syntax

{
   "Actions": [ "string" ],
   "CertificateAuthorityArn": "string",
   "Principal": "string",
   "SourceAccount": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Actions

The actions that the specified AWS service principal can use. These includeIssueCertificate, GetCertificate, andListPermissions.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Valid Values: IssueCertificate | GetCertificate | ListPermissions

Required: Yes

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_ .

Type: String

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: arn:[\w+=/,.@-]+:acm-pca:[\w+=/,.@-]*:[0-9]*:[\w+=,.@-]+(/[\w+=,.@-]+)*

Required: Yes

Principal

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [^*]+

Required: Yes

SourceAccount

The ID of the calling account.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]+

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidArnException

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

HTTP Status Code: 400

InvalidStateException

The state of the private CA does not allow this action to occur.

HTTP Status Code: 400

LimitExceededException

An AWS Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.

HTTP Status Code: 400

PermissionAlreadyExistsException

The designated permission has already been given to the user.

HTTP Status Code: 400

RequestFailedException

The request has failed for an unspecified reason.

HTTP Status Code: 400

ResourceNotFoundException

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreatePermission.

Sample Request

POST / HTTP/1.1
Host: acm.us-east-1.privateca/latest/APIReference/
X-Amz-Target: CertificateManager.CreatePermission
X-Amz-Date: 20190207T170903Z
User-Agent: aws-cli/1.10.20 Python/2.7.3 Linux/3.13.0-83-generic botocore/1.4.11
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS, 
SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, 
Signature=379429306c5e89b9b4be5b35e29c26cc1da38215d8055a5ed0bdda57bcc881cc
                
{
  "Actions": {
    "IssueCertificate",
    "GetCertificate",
    "ListPermissions"
  },
  "CertificateArn":"arn:aws:acm:us-east-1:111122223333:certificate-authority/01234567-89ab-cdef-0123-0123456789ab",
  "Principal":"acm.amazonaws.com",
  "SourceAccount":"012345678901"
}

Example

This example illustrates one usage of CreatePermission.

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 3c8d676d-025e-11e6-8823-93164b47113c
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Thu, Feb 7 2019 17:09:05 GMT

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: