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

GetProfile

Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.

Request Syntax


GET /profile/ProfileId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ProfileId

ID of the Profile.

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

Required: Yes

Request Body

The request does not have a request body.

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

Information about the Profile, including the status of the Profile.

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

ResourceNotFoundException

The resource you are associating is not found.

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

GetProfile Example

This example illustrates one usage of GetProfile.

Sample Request


GET /profile/rp-4987774726example HTTP/1.1
host:route53profiles.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Date:20240319T224652Z
User-Agent: aws-cli/1.32.63 botocore/1.34.63 Python/3.8.18
Authorization: AWS4-HMAC-SHA256 
    Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-1/route53profiles/aws4_request, 
    SignedHeaders=host;x-amz-date;x-amz-security-token
    Signature=[calculated-signature]
{} # RequestBody is empty

Sample Response


HTTP/1.1 200 OK
Date: Tue, 19 Mar 2024 22:46:52 GMT
Content-Type: application/json
Content-Length: 373
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-6e5a93a56a325ab8example

{
    "Profile": {
        "Arn": "arn:aws:route53profiles:us-east-1:123456789012:profile/rp-4987774726example",
        "ClientToken": "0cbc5ae7-4921-4204-bea9-EXAMPLE11111",
        "CreationTime": 1710851044.288,
        "Id": "rp-4987774726example",
        "ModificationTime": 1710851044.288,
        "Name": "test",
        "OwnerId": "123456789012",
        "ShareStatus": "NOT_SHARED",
        "Status": "COMPLETE",
        "StatusMessage": "Created Profile"
    }
}