ListProfiles
Lists all the Route 53 Profiles associated with your AWS account.
Request Syntax
GET /profiles?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of objects that you want to return for this request. If more objects are available, in the response, a
NextTokenvalue, which you can use in a subsequent call to get the next batch of objects, is provided.If you don't specify a value for
MaxResults, up to 100 objects are returned.Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
For the first call to this list request, omit this value.
When you request a list of objects, at most the number of objects specified by
MaxResultsis returned. If more objects are available for retrieval, aNextTokenvalue is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"ProfileSummaries": [
{
"Arn": "string",
"Id": "string",
"Name": "string",
"ShareStatus": "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.
- NextToken
-
If more than
MaxResultsresource associations match the specified criteria, you can submit anotherListProfilesrequest to get the next group of results. In the next request, specify the value ofNextTokenfrom the previous response.Type: String
- ProfileSummaries
-
Summary information about the Profiles.
Type: Array of ProfileSummary objects
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
- InvalidNextTokenException
-
The
NextTokenyou provided isn;t valid.HTTP Status Code: 400
- InvalidParameterException
-
One or more parameters in this request are not valid.
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
ListProfiles Example
This example illustrates one usage of ListProfiles.
Sample Request
GET /profiles HTTP/1.1
host:route53profiles.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Date:20240319T213047Z
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]
# Request body is emptySample Response
HTTP/1.1 200 OK
Date: Tue, 19 Mar 2024 21:30:47 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
{
"ProfileSummaries": [
{
"Arn": "arn:aws:route53profiles:us-east-1:123456789012:profile/rp-4987774726example",
"Id": "rp-4987774726example",
"Name": "test",
"ShareStatus": "NOT_SHARED"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
