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

GetPriceListFileUrl

This feature is in preview release and is subject to change. Your use of AWS Price List API is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).

This returns the URL that you can retrieve your Price List file from. This URL is based on the PriceListArn and FileFormat that you retrieve from the ListPriceLists response.

Request Syntax


{
   "FileFormat": "string",
   "PriceListArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

FileFormat

The format that you want to retrieve your Price List files in. The FileFormat can be obtained from the ListPriceLists response.

Type: String

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

Required: Yes

PriceListArn

The unique identifier that maps to where your Price List files are located. PriceListArn can be obtained from the ListPriceLists response.

Type: String

Length Constraints: Minimum length of 18. Maximum length of 2048.

Pattern: arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9+_/.-]{1,1023}

Required: Yes

Response Syntax


{
   "Url": "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.

Url

The URL to download your Price List file from.

Type: String

Errors

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

AccessDeniedException

General authentication failure. The request wasn't signed correctly.

HTTP Status Code: 400

InternalErrorException

An error on the server occurred during the processing of your request. Try again later.

HTTP Status Code: 500

InvalidParameterException

One or more parameters had an invalid value.

HTTP Status Code: 400

NotFoundException

The requested resource can't be found.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 400

ThrottlingException

You've made too many requests exceeding service quotas.

HTTP Status Code: 400

Examples

The following is a sample request and response of the GetPriceListFileUrl operation.

This example illustrates one usage of GetPriceListFileUrl.

Sample Request


POST / HTTP/1.1
Host: api.pricing.<region>.<domain>
x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>Connection: Keep-Alive
X-Amz-Target: AWSPriceListService.GetPriceListFileUrl{
    "PriceListArn": "arn:aws:pricing:::price-list/aws/AmazonEC2/USD/20220603151047/us-east-1",
    "FileFormat": "json"
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "Url": "https://pricing.us-east-1.amazonaws.com/offers/v1.0/aws/AmazonEC2/20220603151047/us-east-1/index.json"
}