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

CreateTrafficPolicy

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

Request Syntax


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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

CreateTrafficPolicyRequest

Root level tag for the CreateTrafficPolicyRequest parameters.

Required: Yes

Comment

(Optional) Any comments that you want to include about the traffic policy.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

Document

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

Type: String

Length Constraints: Maximum length of 102400.

Required: Yes

Name

The name of the traffic policy.

Type: String

Length Constraints: Maximum length of 512.

Required: Yes

Response Syntax


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

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.

Length Constraints: Maximum length of 1024.

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

CreateTrafficPolicyResponse

Root level tag for the CreateTrafficPolicyResponse parameters.

Required: Yes

TrafficPolicy

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

Type: TrafficPolicy object

Errors

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

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 not valid.

HTTP Status Code: 400

TooManyTrafficPolicies

This traffic policy can't be created because the current account has reached the limit on the number of traffic policies.

For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

To get the current limit for an account, see GetAccountLimit.

To request a higher limit, create a case with the AWS Support Center.

HTTP Status Code: 400

TrafficPolicyAlreadyExists

A traffic policy that has the same value for Name already exists.

HTTP Status Code: 409

Examples

Example Request

This example illustrates one usage of CreateTrafficPolicy.


POST /2013-04-01/trafficpolicy HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<CreateTrafficPolicyRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/">
   <Name>MyTrafficPolicy</Name>
   <Document>traffic policy definition in JSON format</Document>
   <Comment>First traffic policy</Comment>
</CreateTrafficPolicyRequest>

Example Response

This example illustrates one usage of CreateTrafficPolicy.


HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<CreateTrafficPolicyResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/">
   <TrafficPolicy>
      <Id>12345</Id>
      <Version>1</Version>
      <Name>MyTrafficPolicy</Name>
      <Type>A</Type>
      <Document>traffic policy definition in JSON format</Document>
      <Comment>First traffic policy</Comment>
   </TrafficPolicy>
</CreateTrafficPolicyResponse>