Menu
Amazon Route 53
API Reference

CreateTrafficPolicyVersion

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

Request Syntax

Copy
POST /2013-04-01/trafficpolicy/Id HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <CreateTrafficPolicyVersionRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <Comment>string</Comment> <Document>string</Document> </CreateTrafficPolicyVersionRequest>

URI Request Parameters

The request requires the following URI parameters.

Id

The ID of the traffic policy for which you want to create a new version.

Length Constraints: Minimum length of 1. Maximum length of 36.

Request Body

The request accepts the following data in XML format.

CreateTrafficPolicyVersionRequest

Root level tag for the CreateTrafficPolicyVersionRequest parameters.

Required: Yes

Comment

The comment that you specified in the CreateTrafficPolicyVersion request, if any.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

Document

The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.

Type: String

Length Constraints: Maximum length of 102400.

Required: Yes

Response Syntax

Copy
HTTP/1.1 201 Location: Location <?xml version="1.0" encoding="UTF-8"?> <CreateTrafficPolicyVersionResponse> <TrafficPolicy> <Comment>string</Comment> <Document>string</Document> <Id>string</Id> <Name>string</Name> <Type>string</Type> <Version>integer</Version> </TrafficPolicy> </CreateTrafficPolicyVersionResponse>

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The response returns the following HTTP headers.

Location

A unique URL that represents a new traffic policy version.

Length Constraints: Maximum length of 1024.

The following data is returned in XML format by the service.

CreateTrafficPolicyVersionResponse

Root level tag for the CreateTrafficPolicyVersionResponse parameters.

Required: Yes

TrafficPolicy

A complex type that contains settings for the new version of the traffic policy.

Type: TrafficPolicy object

Errors

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

ConcurrentModification

Another user submitted a request to update the object at the same time that you did. Retry the request.

HTTP Status Code: 400

InvalidInput

The input is not valid.

HTTP Status Code: 400

InvalidTrafficPolicyDocument

The format of the traffic policy document that you specified in the Document element is invalid.

HTTP Status Code: 400

NoSuchTrafficPolicy

No traffic policy exists with the specified ID.

HTTP Status Code: 404

Examples

Example Request

Copy
POST /2013-04-01/trafficpolicy/traffic policy ID HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <CreateTrafficPolicyVersionRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <Document>updated traffic policy definition in JSON format</Document> <Comment>Added us-east-2 region to traffic policy</Comment> </CreateTrafficPolicyVersionRequest>

Example Response

Copy
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <CreateTrafficPolicyVersionResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <TrafficPolicy> <Id>12345678-abcd-9876-fedc-1a2b3c4de5f6</Id> <Version>2</Version> <Name>MyTrafficPolicy</Name> <Type>A</Type> <Document>updated traffic policy definition in JSON format</Document> <Comment>Added us-east-2 region to traffic policy</Comment> </TrafficPolicy> </CreateTrafficPolicyVersionResponse>

See Also

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