Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateTemplate

Update template configuration to define the information included in certificates.

Request Syntax


PATCH /templates/TemplateArn HTTP/1.1
Content-type: application/json

{
   "Definition": { ... },
   "ReenrollAllCertificateHolders": boolean
}

URI Request Parameters

The request uses the following URI parameters.

TemplateArn

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

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

Pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\/template\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Definition

Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

Type: TemplateDefinition object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

ReenrollAllCertificateHolders

This setting allows the major version of a template to be increased automatically. All members of Active Directory groups that are allowed to enroll with a template will receive a new certificate issued using that template.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 200

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.

AccessDeniedException

You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your AWS Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an AWS Organizations service control policy (SCP) that affects your AWS account.

HTTP Status Code: 403

ConflictException

This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure with an internal server.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

HTTP Status Code: 400