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

CreateProfile

Creates an empty Route 53 Profile.

Request Syntax


POST /profile HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from CreateProfile. In this case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.

Type: String

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

Required: Yes

Name

A name for the Profile.

Type: String

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

Pattern: ^(?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)$

Required: Yes

Tags

A list of the tag keys and values that you want to associate with the Route 53 Profile.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Profile": { 
      "Arn": "string",
      "ClientToken": "string",
      "CreationTime": number,
      "Id": "string",
      "ModificationTime": number,
      "Name": "string",
      "OwnerId": "string",
      "ShareStatus": "string",
      "Status": "string",
      "StatusMessage": "string"
   }
}

Response Elements

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

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

Profile

The Profile that you just created.

Type: Profile object

Errors

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

AccessDeniedException

The current account doesn't have the IAM permissions required to perform the specified operation.

HTTP Status Code: 400

InvalidParameterException

One or more parameters in this request are not valid.

HTTP Status Code: 400

LimitExceededException

The request caused one or more limits to be exceeded.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

ValidationException

You have provided an invalid command.

HTTP Status Code: 400

Examples

CreateProfile Example

This example illustrates one usage of CreateProfile.

Sample Request


POST /profile HTTP/1.1
host:route53profiles.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 71
X-Amz-Date:20240319T214228Z
User-Agent: aws-cli/1.32.63 botocore/1.34.63 Python/3.8.18
Content-Type: application/json
Authorization: AWS4-HMAC-SHA256 
    Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-1/route53profiles/aws4_request, 
    SignedHeaders=content-type;host;x-amz-date;x-amz-security-token
    Signature=[calculated-signature]
{
    "Name": "test", 
    "ClientToken": "c60a235a-e786-40bc-a5a4-f12EXAMPLE"
}

Sample Response


HTTP/1.1 200 OK
Date: Tue, 19 Mar 2024 21:53:14 GMT
Content-Type: application/json
Content-Length: 371
Connection: keep-alive
x-amzn-RequestId: dcd9d91e-1a5a-481f-82b7-bafe7dexample
Access-Control-Allow-Origin: *
x-amz-apigw-id: U5eX0FdmIexample= 
X-Amzn-Trace-Id: Root=1-65fa10fe-6e5a93a56a32afdfsd3example
{
    "Profile": {
        "Arn": "arn:aws:route53profiles:us-east-1:123456789012:profile/rp-6ffe47d5example",        
        "ClientToken": "c60a235a-e786-40bc-a5a4-f12EXAMPLE",
        "CreationTime": 1710885194.55,
        "Id": "rp-6ffe47d5example",        
        "ModificationTime": 1710885194.55,
        "Name": "test",
        "OwnerId": "123456789012",
        "ShareStatus": "NOT_SHARED",
        "Status": "COMPLETE",
        "StatusMessage": "Created Profile"
    }
}