Class ListPermissionsCommandProtected

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

These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services 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 Amazon Web Services Private CA.

Example

Use a bare-bones client and the command you need to make an API call.

import { ACMPCAClient, ListPermissionsCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import
// const { ACMPCAClient, ListPermissionsCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import
const client = new ACMPCAClient(config);
const input = { // ListPermissionsRequest
  CertificateAuthorityArn: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListPermissionsCommand(input);
const response = await client.send(command);
// { // ListPermissionsResponse
//   Permissions: [ // PermissionList
//     { // Permission
//       CertificateAuthorityArn: "STRING_VALUE",
//       CreatedAt: new Date("TIMESTAMP"),
//       Principal: "STRING_VALUE",
//       SourceAccount: "STRING_VALUE",
//       Actions: [ // ActionList
//         "IssueCertificate" || "GetCertificate" || "ListPermissions",
//       ],
//       Policy: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListPermissionsCommandInput

Returns

ListPermissionsCommandOutput

See

• ListPermissionsCommandInput for command's input shape.
• ListPermissionsCommandOutput for command's response shape.
• config for ACMPCAClient's config shape.

Throws

InvalidArnException (client fault)

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

Throws

InvalidNextTokenException (client fault)

The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.

Throws

InvalidStateException (client fault)

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

Throws

RequestFailedException (client fault)

The request has failed for an unspecified reason.

Throws

ResourceNotFoundException (client fault)

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

Throws

ACMPCAServiceException

Base exception class for all service exceptions from ACMPCA service.