openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 16.6 kB

JSON

{"openapi":"3.0.0","info":{"version":"2017-10-15","x-release":"v4","title":"AWS Price List Service","description":"AWS Price List Service API (AWS Price List Service) is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The AWS Price List Service uses standardized product attributes such as <code>Location</code>, <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at the SKU level. You can use the AWS Price List Service to build cost control and scenario planning tools, reconcile billing data, forecast future spend for budgeting purposes, and provide cost benefit analysis that compare your internal workloads with AWS. Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then <code>GetServices</code> with a service code to retreive the attribute names for that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code> to see what values are available for an attribute. With the service code and an attribute name and value, you can use <code>GetProducts</code> to find specific products that you're interested in, such as an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> <code>volumeType</code>. Service Endpoint AWS Price List Service API provides the following two endpoints: <ul> <li> https://api.pricing.us-east-1.amazonaws.com </li> <li> https://api.pricing.ap-south-1.amazonaws.com </li> </ul>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"pricing","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pricing-2017-10-15.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/pricing/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"DescribeServices","description":"Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as <code>AmazonEC2</code>, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are <code>volumeType</code>, <code>maxIopsVolume</code>, <code>operation</code>, <code>locationType</code>, and <code>instanceCapacity10xlarge</code>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeServicesResponse"}}}},"480":{"description":"InternalErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InvalidNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidNextTokenException"}}}},"484":{"description":"ExpiredNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpiredNextTokenException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeServicesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetAttributeValues":{"post":{"operationId":"GetAttributeValues","description":"Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs\">Offer File Definitions</a> in the <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html\">AWS Billing and Cost Management User Guide</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAttributeValuesResponse"}}}},"480":{"description":"InternalErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InvalidNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidNextTokenException"}}}},"484":{"description":"ExpiredNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpiredNextTokenException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAttributeValuesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetProducts":{"post":{"operationId":"GetProducts","description":"Returns a list of all products that match the filter criteria.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductsResponse"}}}},"480":{"description":"InternalErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InvalidNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidNextTokenException"}}}},"484":{"description":"ExpiredNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpiredNextTokenException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://api.pricing.amazonaws.com/"},{"url":"http://api.pricing.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"DescribeServicesResponse":{"type":"object","example":{"FormatVersion":"aws_v1","NextToken":"abcdefg123","Services":[{"AttributeNames":["volumeType","maxIopsvolume","instanceCapacity10xlarge","locationType","operation"],"ServiceCode":"AmazonEC2"}]},"properties":{"Services":{"$ref":"#/components/schemas/ServiceList"},"FormatVersion":{"$ref":"#/components/schemas/String"},"NextToken":{"$ref":"#/components/schemas/String"}}},"DescribeServicesRequest":{"type":"object","example":{"FormatVersion":"aws_v1","MaxResults":1,"ServiceCode":"AmazonEC2"},"properties":{"ServiceCode":{"$ref":"#/components/schemas/String"},"FormatVersion":{"$ref":"#/components/schemas/String"},"NextToken":{"$ref":"#/components/schemas/String"},"MaxResults":{"$ref":"#/components/schemas/BoxedInteger"}}},"InternalErrorException":{"type":"object","properties":{"Message":{"$ref":"#/components/schemas/errorMessage"}},"description":"An error on the server occurred during the processing of your request. Try again later."},"InvalidParameterException":{"type":"object","properties":{"Message":{"$ref":"#/components/schemas/errorMessage"}},"description":"One or more parameters had an invalid value."},"NotFoundException":{"type":"object","properties":{"Message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The requested resource can't be found."},"InvalidNextTokenException":{"type":"object","properties":{"Message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The pagination token is invalid. Try again without a pagination token."},"ExpiredNextTokenException":{"type":"object","properties":{"Message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The pagination token expired. Try again without a pagination token."},"GetAttributeValuesResponse":{"type":"object","example":{"AttributeValues":[{"Value":"Throughput Optimized HDD"},{"Value":"Provisioned IOPS"}],"NextToken":"GpgauEXAMPLEezucl5LV0w==:7GzYJ0nw0DBTJ2J66EoTIIynE6O1uXwQtTRqioJzQadBnDVgHPzI1en4BUQnPCLpzeBk9RQQAWaFieA4+DapFAGLgk+Z/9/cTw9GldnPOHN98+FdmJP7wKU3QQpQ8MQr5KOeBkIsAqvAQYdL0DkL7tHwPtE5iCEByAmg9gcC/yBU1vAOsf7R3VaNN4M5jMDv3woSWqASSIlBVB6tgW78YL22KhssoItM/jWW+aP6Jqtq4mldxp/ct6DWAl+xLFwHU/CbketimPPXyqHF3/UXDw=="},"properties":{"AttributeValues":{"$ref":"#/components/schemas/AttributeValueList"},"NextToken":{"$ref":"#/components/schemas/String"}}},"GetAttributeValuesRequest":{"type":"object","required":["ServiceCode","AttributeName"],"example":{"AttributeName":"volumeType","MaxResults":2,"ServiceCode":"AmazonEC2"},"properties":{"ServiceCode":{"$ref":"#/components/schemas/String"},"AttributeName":{"$ref":"#/components/schemas/String"},"NextToken":{"$ref":"#/components/schemas/String"},"MaxResults":{"$ref":"#/components/schemas/BoxedInteger"}}},"GetProductsResponse":{"type":"object","example":{"FormatVersion":"aws_v1","NextToken":"57r3EXAMPLEujbzWfHF7Ciw==:ywSmZsD3mtpQmQLQ5XfOsIMkYybSj+vAT+kGmwMFq+K9DGmIoJkz7lunVeamiOPgthdWSO2a7YKojCO+zY4dJmuNl2QvbNhXs+AJ2Ufn7xGmJncNI2TsEuAsVCUfTAvAQNcwwamtk6XuZ4YdNnooV62FjkV3ZAn40d9+wAxV7+FImvhUHi/+f8afgZdGh2zPUlH8jlV9uUtj0oHp8+DhPUuHXh+WBII1E/aoKpPSm3c=","PriceList":["{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"storageMedia\":\"SSD-backed\",\"maxThroughputvolume\":\"320 MB/sec\",\"volumeType\":\"Provisioned IOPS\",\"maxIopsvolume\":\"20000\",\"servicecode\":\"AmazonEC2\",\"usagetype\":\"CAN1-EBS:VolumeUsage.piops\",\"locationType\":\"AWS Region\",\"location\":\"Canada (Central)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"maxVolumeSize\":\"16 TiB\",\"operation\":\"\"},\"sku\":\"WQGC34PB2AWS8R4U\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF\":{\"priceDimensions\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.138 per GB-month of Provisioned IOPS SSD (io1) provisioned storage - Canada (Central)\",\"appliesTo\":[],\"rateCode\":\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1380000000\"}}},\"sku\":\"WQGC34PB2AWS8R4U\",\"effectiveDate\":\"2017-08-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20170901182201\",\"publicationDate\":\"2017-09-01T18:22:01Z\"}"]},"properties":{"FormatVersion":{"$ref":"#/components/schemas/String"},"PriceList":{"$ref":"#/components/schemas/PriceList"},"NextToken":{"$ref":"#/components/schemas/String"}}},"GetProductsRequest":{"type":"object","example":{"Filters":[{"Field":"ServiceCode","Type":"TERM_MATCH","Value":"AmazonEC2"},{"Field":"volumeType","Type":"TERM_MATCH","Value":"Provisioned IOPS"}],"FormatVersion":"aws_v1","MaxResults":1},"properties":{"ServiceCode":{"$ref":"#/components/schemas/String"},"Filters":{"$ref":"#/components/schemas/Filters"},"FormatVersion":{"$ref":"#/components/schemas/String"},"NextToken":{"$ref":"#/components/schemas/String"},"MaxResults":{"$ref":"#/components/schemas/BoxedInteger"}}},"String":{"type":"string"},"AttributeNameList":{"type":"array","items":{"$ref":"#/components/schemas/String"}},"AttributeValue":{"type":"object","properties":{"Value":{"$ref":"#/components/schemas/String"}},"description":"The values of a given attribute, such as <code>Throughput Optimized HDD</code> or <code>Provisioned IOPS</code> for the <code>Amazon EC2</code> <code>volumeType</code> attribute."},"AttributeValueList":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValue"}},"BoxedInteger":{"type":"integer","minimum":1,"maximum":100},"ServiceList":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"errorMessage":{"type":"string"},"FilterType":{"type":"string","enum":["TERM_MATCH"]},"Filter":{"type":"object","required":["Type","Field","Value"],"properties":{"Type":{"$ref":"#/components/schemas/FilterType"},"Field":{"$ref":"#/components/schemas/String"},"Value":{"$ref":"#/components/schemas/String"}},"description":"The constraints that you want all returned products to match."},"Filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"PriceList":{"type":"array","items":{"$ref":"#/components/schemas/PriceListItemJSON"}},"PriceListItemJSON":{"type":"string"},"Service":{"type":"object","properties":{"ServiceCode":{"$ref":"#/components/schemas/String"},"AttributeNames":{"$ref":"#/components/schemas/AttributeNameList"}},"description":"The metadata for a service, such as the service code and available attribute names."}}}}