Module Smaws_Client_Pricing.Types

type nonrec error_message = string
type nonrec value = string
type nonrec throttling_exception = {
  1. message : error_message option;
}

You've made too many requests exceeding service quotas.

type nonrec synthesized_json_price_list_json_item = string
type nonrec string_ = string
type nonrec attribute_name_list = string_ list
type nonrec service = {
  1. attribute_names : attribute_name_list option;
    (*

    The attributes that are available for this service.

    *)
  2. service_code : string_;
    (*

    The code for the Amazon Web Services service.

    *)
}

The metadata for a service, such as the service code and available attribute names.

type nonrec service_list = service list
type nonrec service_code = string
type nonrec resource_not_found_exception = {
  1. message : error_message option;
}

The requested resource can't be found.

type nonrec region_code = string
type nonrec price_list_arn = string
type nonrec currency_code = string
type nonrec file_format = string
type nonrec file_formats = file_format list
type nonrec price_list = {
  1. file_formats : file_formats option;
    (*

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

    *)
  2. currency_code : currency_code option;
    (*

    The three alphabetical character ISO-4217 currency code the Price List files are denominated in.

    *)
  3. region_code : region_code option;
    (*

    This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

    *)
  4. price_list_arn : price_list_arn option;
    (*

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

    *)
}

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

This is the type of price list references that match your request.

type nonrec price_lists = price_list list
type nonrec price_list_json_items = synthesized_json_price_list_json_item list
type nonrec not_found_exception = {
  1. message : error_message option;
}

The requested resource can't be found.

type nonrec max_results = int
type nonrec list_price_lists_response = {
  1. next_token : string_ option;
    (*

    The pagination token that indicates the next set of results to retrieve.

    *)
  2. price_lists : price_lists option;
    (*

    The type of price list references that match your request.

    *)
}
type nonrec effective_date = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec list_price_lists_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : string_ option;
    (*

    The pagination token that indicates the next set of results that you want to retrieve.

    *)
  3. currency_code : currency_code;
    (*

    The three alphabetical character ISO-4217 currency code that the Price List files are denominated in.

    *)
  4. region_code : region_code option;
    (*

    This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

    *)
  5. effective_date : effective_date;
    (*

    The date that the Price List file prices are effective from.

    *)
  6. service_code : service_code;
    (*

    The service code or the Savings Plans service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the DescribeServices API.

    To retrieve the Reserved Instance and Compute Savings Plans price lists, use ComputeSavingsPlans.

    To retrieve Machine Learning Savings Plans price lists, use MachineLearningSavingsPlans.

    *)
}
type nonrec invalid_parameter_exception = {
  1. message : error_message option;
}

One or more parameters had an invalid value.

type nonrec invalid_next_token_exception = {
  1. message : error_message option;
}

The pagination token is invalid. Try again without a pagination token.

type nonrec internal_error_exception = {
  1. message : error_message option;
}

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

type nonrec expired_next_token_exception = {
  1. message : error_message option;
}

The pagination token expired. Try again without a pagination token.

type nonrec access_denied_exception = {
  1. message : error_message option;
}

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

type nonrec format_version = string
type nonrec get_products_response = {
  1. next_token : string_ option;
    (*

    The pagination token that indicates the next set of results to retrieve.

    *)
  2. price_list : price_list_json_items option;
    (*

    The list of products that match your filters. The list contains both the product metadata and the price information.

    *)
  3. format_version : format_version option;
    (*

    The format version of the response. For example, aws_v1.

    *)
}
type nonrec filter_type =
  1. | NONE_OF
  2. | ANY_OF
  3. | CONTAINS
  4. | EQUALS
  5. | TERM_MATCH
type nonrec field = string
type nonrec filter = {
  1. value : value;
    (*

    The service code or attribute value that you want to filter by. If you're filtering by service code this is the actual service code, such as AmazonEC2. If you're filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.

    *)
  2. field : field;
    (*

    The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.

    Valid values include: ServiceCode, and all attribute names

    For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.

    *)
  3. type_ : filter_type;
    (*

    The type of filter that you want to use.

    Valid values are:

    • TERM_MATCH: Returns only products that match both the given filter field and the given value.
    • EQUALS: Returns products that have a field value exactly matching the provided value.
    • CONTAINS: Returns products where the field value contains the provided value as a substring.
    • ANY_OF: Returns products where the field value is any of the provided values.
    • NONE_OF: Returns products where the field value is not any of the provided values.
    *)
}

The constraints that you want all returned products to match.

type nonrec filters = filter list
type nonrec get_products_max_results = int
type nonrec get_products_request = {
  1. max_results : get_products_max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : string_ option;
    (*

    The pagination token that indicates the next set of results that you want to retrieve.

    *)
  3. format_version : format_version option;
    (*

    The format version that you want the response to be in.

    Valid values are: aws_v1

    *)
  4. filters : filters option;
    (*

    The list of filters that limit the returned products. only products that match all filters are returned.

    *)
  5. service_code : string_;
    (*

    The code for the service whose products you want to retrieve.

    *)
}
type nonrec get_price_list_file_url_response = {
  1. url : string_ option;
    (*

    The URL to download your Price List file from.

    *)
}
type nonrec get_price_list_file_url_request = {
  1. file_format : file_format;
    (*

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

    *)
  2. price_list_arn : price_list_arn;
    (*

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

    *)
}
type nonrec attribute_value = {
  1. value : string_ option;
    (*

    The specific value of an attributeName.

    *)
}

The values of a given attribute, such as Throughput Optimized HDD or Provisioned IOPS for the Amazon EC2 volumeType attribute.

type nonrec attribute_value_list = attribute_value list
type nonrec get_attribute_values_response = {
  1. next_token : string_ option;
    (*

    The pagination token that indicates the next set of results to retrieve.

    *)
  2. attribute_values : attribute_value_list option;
    (*

    The list of values for an attribute. For example, Throughput Optimized HDD and Provisioned IOPS are two available values for the AmazonEC2 volumeType.

    *)
}
type nonrec get_attribute_values_max_results = int
type nonrec get_attribute_values_request = {
  1. max_results : get_attribute_values_max_results option;
    (*

    The maximum number of results to return in response.

    *)
  2. next_token : string_ option;
    (*

    The pagination token that indicates the next set of results that you want to retrieve.

    *)
  3. attribute_name : string_;
    (*

    The name of the attribute that you want to retrieve the values for, such as volumeType.

    *)
  4. service_code : string_;
    (*

    The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use AmazonEC2.

    *)
}
type nonrec describe_services_response = {
  1. next_token : string_ option;
    (*

    The pagination token for the next set of retrievable results.

    *)
  2. format_version : format_version option;
    (*

    The format version of the response. For example, aws_v1.

    *)
  3. services : service_list option;
    (*

    The service metadata for the service or services in the response.

    *)
}
type nonrec describe_services_max_results = int
type nonrec describe_services_request = {
  1. max_results : describe_services_max_results option;
    (*

    The maximum number of results that you want returned in the response.

    *)
  2. next_token : string_ option;
    (*

    The pagination token that indicates the next set of results that you want to retrieve.

    *)
  3. format_version : format_version option;
    (*

    The format version that you want the response to be in.

    Valid values are: aws_v1

    *)
  4. service_code : string_ option;
    (*

    The code for the service whose information you want to retrieve, such as AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To retrieve a list of all services, leave this blank.

    *)
}