The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
https://ce.us-east-1.amazonaws.com
For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.
", + "service": "The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
https://ce.us-east-1.amazonaws.com
For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.
", "operations": { - "GetCostAndUsage": "Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
", "GetDimensionValues": "Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
", - "GetReservationCoverage": "Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
To determine valid values for a dimension, use the GetDimensionValues operation.
Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.
For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large, because that is the smallest size instance in the c4 instance family.
Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
To determine valid values for a dimension, use the GetDimensionValues operation.
Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.
For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.
Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
" }, @@ -21,13 +21,13 @@ "AmortizedRecurringFee": { "base": null, "refs": { - "ReservationAggregates$AmortizedRecurringFee": "The monthly cost of your RI, amortized over the RI period.
" + "ReservationAggregates$AmortizedRecurringFee": "The monthly cost of your reservation, amortized over the reservation period.
" } }, "AmortizedUpfrontFee": { "base": null, "refs": { - "ReservationAggregates$AmortizedUpfrontFee": "The upfront cost of your RI, amortized over the RI period.
" + "ReservationAggregates$AmortizedUpfrontFee": "The upfront cost of your reservation, amortized over the reservation period.
" } }, "AttributeType": { @@ -47,7 +47,7 @@ "refs": { "DimensionValuesWithAttributes$Attributes": "The attribute that applies to a specific Dimension.
The attributes for this group of reservations.
", - "ReservationUtilizationGroup$Attributes": "The attributes for this group of RIs.
" + "ReservationUtilizationGroup$Attributes": "The attributes for this group of reservations.
" } }, "BillExpirationException": { @@ -58,14 +58,14 @@ "Context": { "base": null, "refs": { - "GetDimensionValuesRequest$Context": "The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE the resulting dimension values can be used in the GetCostAndUsage operation.
If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
If you set the context to RESERVATIONS, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.
If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
If you set the context to RESERVATIONS, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
The amount of instance usage that a reservation covered.
", "refs": { "CoverageByTime$Total": "The total reservation coverage, in hours.
", - "GetReservationCoverageResponse$Total": "The total amount of instance usage that is covered by a reservation.
", + "GetReservationCoverageResponse$Total": "The total amount of instance usage that a reservation covered.
", "ReservationCoverageGroup$Coverage": "How much instance usage this group of reservations covered.
" } }, @@ -75,16 +75,34 @@ "CoveragesByTime$member": null } }, + "CoverageCost": { + "base": "How much it cost to run an instance.
", + "refs": { + "Coverage$CoverageCost": "The amount of cost that the reservation covered.
" + } + }, "CoverageHours": { "base": "How long a running instance either used a reservation or was On-Demand.
", "refs": { - "Coverage$CoverageHours": "The amount of instance usage that a reservation covered, in hours.
" + "Coverage$CoverageHours": "The amount of instance usage that the reservation covered, in hours.
" } }, "CoverageHoursPercentage": { "base": null, "refs": { - "CoverageHours$CoverageHoursPercentage": "The percentage of instance hours that are covered by a reservation.
" + "CoverageHours$CoverageHoursPercentage": "The percentage of instance hours that a reservation covered.
" + } + }, + "CoverageNormalizedUnits": { + "base": "The amount of instance usage, in normalized units. Normalized units enable you to see your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose you run an xlarge instance and a 2xlarge instance. If you run both instances for the same amount of time, the 2xlarge instance uses twice as much of your reservation as the xlarge instance, even though both instances show only one instance-hour. Using normalized units instead of instance-hours, the xlarge instance used 8 normalized units, and the 2xlarge instance used 16 normalized units.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
", + "refs": { + "Coverage$CoverageNormalizedUnits": "The amount of instance usage that the reservation covered, in normalized units.
" + } + }, + "CoverageNormalizedUnitsPercentage": { + "base": null, + "refs": { + "CoverageNormalizedUnits$CoverageNormalizedUnitsPercentage": "The percentage of your used instance normalized units that a reservation covers.
" } }, "CoveragesByTime": { @@ -101,23 +119,23 @@ "DateInterval": { "base": "The time period that you want the usage and costs for.
", "refs": { - "CoverageByTime$TimePeriod": "The period over which this coverage was used.
", + "CoverageByTime$TimePeriod": "The period that this coverage was used over.
", "ForecastResult$TimePeriod": "The period of time that the forecast covers.
", "GetCostAndUsageRequest$TimePeriod": "Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The period of time that you want the forecast to cover.
", "GetDimensionValuesRequest$TimePeriod": "The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The time period covered by a result.
", - "UtilizationByTime$TimePeriod": "The period of time over which this utilization was used.
" + "ResultByTime$TimePeriod": "The time period that the result covers.
", + "UtilizationByTime$TimePeriod": "The period of time that this utilization was used for.
" } }, "Dimension": { "base": null, "refs": { "DimensionValues$Key": "The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.
The name of the dimension. Each Dimension is available for different a Context. For more information, see Context.
The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.
The filters that you used to filter your request. Some dimensions are available only for a specific context:
If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
If you set the context to RESERVATIONS, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
The filters that you used to filter your request. Some dimensions are available only for a specific context.
If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
If you set the context to RESERVATIONS, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
Details about the EC2 instances that AWS recommends that you purchase.
", + "base": "Details about the Amazon EC2 instances that AWS recommends that you purchase.
", "refs": { - "InstanceDetails$EC2InstanceDetails": "The EC2 instances that AWS recommends that you purchase.
" + "InstanceDetails$EC2InstanceDetails": "The Amazon EC2 instances that AWS recommends that you purchase.
" } }, "EC2Specification": { - "base": "The EC2 hardware specifications that you want AWS to provide recommendations for.
", + "base": "The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.
", "refs": { - "ServiceSpecification$EC2Specification": "The EC2 hardware specifications that you want AWS to provide recommendations for.
" + "ServiceSpecification$EC2Specification": "The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.
" } }, "ESInstanceDetails": { - "base": "Details about the ES instances that AWS recommends that you purchase.
", + "base": "Details about the Amazon ES instances that AWS recommends that you purchase.
", "refs": { "InstanceDetails$ESInstanceDetails": "The Amazon ES instances that AWS recommends that you purchase.
" } }, "ElastiCacheInstanceDetails": { - "base": "Details about the ElastiCache instances that AWS recommends that you purchase.
", + "base": "Details about the Amazon ElastiCache instances that AWS recommends that you purchase.
", "refs": { "InstanceDetails$ElastiCacheInstanceDetails": "The ElastiCache instances that AWS recommends that you purchase.
" } @@ -181,7 +199,7 @@ "Estimated": { "base": null, "refs": { - "ResultByTime$Estimated": "Whether this result is estimated.
" + "ResultByTime$Estimated": "Whether the result is estimated.
" } }, "Expression": { @@ -191,8 +209,8 @@ "Expressions$member": null, "GetCostAndUsageRequest$Filter": "Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.
", - "GetReservationCoverageRequest$Filter": "Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.
If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
SCOPE
TENANCY
GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.
If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
SCOPE
TENANCY
GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
Whether the recommendation is for a current generation instance.
", + "EC2InstanceDetails$CurrentGeneration": "Whether the recommendation is for a current-generation instance.
", "EC2InstanceDetails$SizeFlexEligible": "Whether the recommended reservation is size flexible.
", - "ESInstanceDetails$CurrentGeneration": "Whether the recommendation is for a current generation instance.
", + "ESInstanceDetails$CurrentGeneration": "Whether the recommendation is for a current-generation instance.
", "ESInstanceDetails$SizeFlexEligible": "Whether the recommended reservation is size flexible.
", "ElastiCacheInstanceDetails$CurrentGeneration": "Whether the recommendation is for a current generation instance.
", "ElastiCacheInstanceDetails$SizeFlexEligible": "Whether the recommended reservation is size flexible.
", - "RDSInstanceDetails$CurrentGeneration": "Whether the recommendation is for a current generation instance.
", + "RDSInstanceDetails$CurrentGeneration": "Whether the recommendation is for a current-generation instance.
", "RDSInstanceDetails$SizeFlexEligible": "Whether the recommended reservation is size flexible.
", - "RedshiftInstanceDetails$CurrentGeneration": "Whether the recommendation is for a current generation instance.
", + "RedshiftInstanceDetails$CurrentGeneration": "Whether the recommendation is for a current-generation instance.
", "RedshiftInstanceDetails$SizeFlexEligible": "Whether the recommended reservation is size flexible.
" } }, @@ -264,7 +282,7 @@ "ReservationPurchaseRecommendationDetail$RecommendedNumberOfInstancesToPurchase": "The number of instances that AWS recommends that you purchase.
", "ReservationPurchaseRecommendationDetail$RecommendedNormalizedUnitsToPurchase": "The number of normalized units that AWS recommends that you purchase.
", "ReservationPurchaseRecommendationDetail$MinimumNumberOfInstancesUsedPerHour": "The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
", - "ReservationPurchaseRecommendationDetail$MinimumNormalizedUnitsUsedPerHour": "The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
", + "ReservationPurchaseRecommendationDetail$MinimumNormalizedUnitsUsedPerHour": "The minimum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
", "ReservationPurchaseRecommendationDetail$MaximumNumberOfInstancesUsedPerHour": "The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
", "ReservationPurchaseRecommendationDetail$MaximumNormalizedUnitsUsedPerHour": "The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
", "ReservationPurchaseRecommendationDetail$AverageNumberOfInstancesUsedPerHour": "The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
", @@ -316,7 +334,7 @@ } }, "GetReservationCoverageRequest": { - "base": "You can use the following request parameters to query for how much of your instance usage is covered by a reservation.
", + "base": "You can use the following request parameters to query for how much of your instance usage a reservation covered.
", "refs": { } }, @@ -358,20 +376,20 @@ "Granularity": { "base": null, "refs": { - "GetCostAndUsageRequest$Granularity": "Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.
How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.
If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.
If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.
Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.
The GetCostAndUsageRequest operation supports only DAILY and MONTHLY granularities.
How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.
The GetCostForecast operation supports only DAILY and MONTHLY granularities.
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.
If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.
The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.
If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.
The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.
One level of grouped data within the results.
", + "base": "One level of grouped data in the results.
", "refs": { "Groups$member": null } }, "GroupDefinition": { - "base": "Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.
", + "base": "Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.
", "refs": { "GroupDefinitions$member": null } @@ -400,7 +418,7 @@ "Groups": { "base": null, "refs": { - "ResultByTime$Groups": "The groups that are included in this time period.
" + "ResultByTime$Groups": "The groups that this time period includes.
" } }, "InstanceDetails": { @@ -460,7 +478,8 @@ "MetricNames": { "base": null, "refs": { - "GetCostAndUsageRequest$Metrics": "Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsage requests.
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsage requests.
How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed.
How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed.
Whether you want a recommendation for standard or convertible reservations.
" } }, + "OnDemandCost": { + "base": null, + "refs": { + "CoverageCost$OnDemandCost": "How much an On-Demand instance cost.
" + } + }, "OnDemandCostOfRIHoursUsed": { "base": null, "refs": { - "ReservationAggregates$OnDemandCostOfRIHoursUsed": "How much your RIs would cost if charged On-Demand rates.
" + "ReservationAggregates$OnDemandCostOfRIHoursUsed": "How much your reservation would cost if charged On-Demand rates.
" } }, "OnDemandHours": { "base": null, "refs": { - "CoverageHours$OnDemandHours": "The number of instance running hours that are covered by On-Demand Instances.
" + "CoverageHours$OnDemandHours": "The number of instance running hours that On-Demand Instances covered.
" + } + }, + "OnDemandNormalizedUnits": { + "base": null, + "refs": { + "CoverageNormalizedUnits$OnDemandNormalizedUnits": "The number of normalized units that are covered by On-Demand Instances instead of a reservation.
" } }, "PageSize": { @@ -555,13 +586,19 @@ "PurchasedHours": { "base": null, "refs": { - "ReservationAggregates$PurchasedHours": "How many RI hours that you purchased.
" + "ReservationAggregates$PurchasedHours": "How many reservation hours that you purchased.
" + } + }, + "PurchasedUnits": { + "base": null, + "refs": { + "ReservationAggregates$PurchasedUnits": "How many Amazon EC2 reservation hours that you purchased, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
" } }, "RDSInstanceDetails": { - "base": "Details about the RDS instances that AWS recommends that you purchase.
", + "base": "Details about the Amazon RDS instances that AWS recommends that you purchase.
", "refs": { - "InstanceDetails$RDSInstanceDetails": "The RDS instances that AWS recommends that you purchase.
" + "InstanceDetails$RDSInstanceDetails": "The Amazon RDS instances that AWS recommends that you purchase.
" } }, "RedshiftInstanceDetails": { @@ -576,11 +613,11 @@ } }, "ReservationAggregates": { - "base": "The aggregated numbers for your Reserved Instance (RI) usage.
", + "base": "The aggregated numbers for your reservation usage.
", "refs": { - "GetReservationUtilizationResponse$Total": "The total amount of time that you utilized your RIs.
", - "ReservationUtilizationGroup$Utilization": "How much you used this group of RIs.
", - "UtilizationByTime$Total": "The total number of RI hours that were used.
" + "GetReservationUtilizationResponse$Total": "The total amount of time that you used your RIs.
", + "ReservationUtilizationGroup$Utilization": "How much you used this group of reservations.
", + "UtilizationByTime$Total": "The total number of reservation hours that were used.
" } }, "ReservationCoverageGroup": { @@ -592,19 +629,19 @@ "ReservationCoverageGroups": { "base": null, "refs": { - "CoverageByTime$Groups": "The groups of instances that are covered by a reservation.
" + "CoverageByTime$Groups": "The groups of instances that the reservation covered.
" } }, "ReservationGroupKey": { "base": null, "refs": { - "ReservationUtilizationGroup$Key": "The key for a specific RI attribute.
" + "ReservationUtilizationGroup$Key": "The key for a specific reservation attribute.
" } }, "ReservationGroupValue": { "base": null, "refs": { - "ReservationUtilizationGroup$Value": "The value of a specific RI attribute.
" + "ReservationUtilizationGroup$Value": "The value of a specific reservation attribute.
" } }, "ReservationPurchaseRecommendation": { @@ -644,7 +681,7 @@ } }, "ReservationUtilizationGroup": { - "base": "A group of Reserved Instances (RIs) that share a set of attributes.
", + "base": "A group of reservations that share a set of attributes.
", "refs": { "ReservationUtilizationGroups$member": null } @@ -652,13 +689,19 @@ "ReservationUtilizationGroups": { "base": null, "refs": { - "UtilizationByTime$Groups": "The groups that are included in this utilization result.
" + "UtilizationByTime$Groups": "The groups that this utilization result uses.
" } }, "ReservedHours": { "base": null, "refs": { - "CoverageHours$ReservedHours": "The number of instance running hours that are covered by reservations.
" + "CoverageHours$ReservedHours": "The number of instance running hours that reservations covered.
" + } + }, + "ReservedNormalizedUnits": { + "base": null, + "refs": { + "CoverageNormalizedUnits$ReservedNormalizedUnits": "The number of normalized units that a reservation covers.
" } }, "ResultByTime": { @@ -683,7 +726,7 @@ "ServiceSpecification": { "base": "Hardware specifications for the service that you want recommendations for.
", "refs": { - "GetReservationPurchaseRecommendationRequest$ServiceSpecification": "The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.
", + "GetReservationPurchaseRecommendationRequest$ServiceSpecification": "The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.
", "ReservationPurchaseRecommendation$ServiceSpecification": "Hardware specifications for the service that you want recommendations for.
" } }, @@ -691,7 +734,7 @@ "base": null, "refs": { "GetTagsRequest$TagKey": "The key of the tag that you want to return values for.
", - "TagValues$Key": "The key for a tag.
" + "TagValues$Key": "The key for the tag.
" } }, "TagList": { @@ -716,13 +759,19 @@ "TotalActualHours": { "base": null, "refs": { - "ReservationAggregates$TotalActualHours": "The total number of RI hours that you used.
" + "ReservationAggregates$TotalActualHours": "The total number of reservation hours that you used.
" + } + }, + "TotalActualUnits": { + "base": null, + "refs": { + "ReservationAggregates$TotalActualUnits": "The total number of Amazon EC2 reservation hours that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
" } }, "TotalAmortizedFee": { "base": null, "refs": { - "ReservationAggregates$TotalAmortizedFee": "The total cost of your RI, amortized over the RI period.
" + "ReservationAggregates$TotalAmortizedFee": "The total cost of your reservation, amortized over the reservation period.
" } }, "TotalPotentialRISavings": { @@ -737,10 +786,22 @@ "CoverageHours$TotalRunningHours": "The total instance usage, in hours.
" } }, + "TotalRunningNormalizedUnits": { + "base": null, + "refs": { + "CoverageNormalizedUnits$TotalRunningNormalizedUnits": "The total number of normalized units that you used.
" + } + }, "UnusedHours": { "base": null, "refs": { - "ReservationAggregates$UnusedHours": "The number of RI hours that you didn't use.
" + "ReservationAggregates$UnusedHours": "The number of reservation hours that you didn't use.
" + } + }, + "UnusedUnits": { + "base": null, + "refs": { + "ReservationAggregates$UnusedUnits": "The number of Amazon EC2 reservation hours that you didn't use, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
" } }, "UtilizationByTime": { @@ -752,13 +813,19 @@ "UtilizationPercentage": { "base": null, "refs": { - "ReservationAggregates$UtilizationPercentage": "The percentage of RI time that you used.
" + "ReservationAggregates$UtilizationPercentage": "The percentage of reservation time that you used.
" + } + }, + "UtilizationPercentageInUnits": { + "base": null, + "refs": { + "ReservationAggregates$UtilizationPercentageInUnits": "The percentage of Amazon EC2 reservation time that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
" } }, "UtilizationsByTime": { "base": null, "refs": { - "GetReservationUtilizationResponse$UtilizationsByTime": "The amount of time that you utilized your RIs.
" + "GetReservationUtilizationResponse$UtilizationsByTime": "The amount of time that you used your RIs.
" } }, "Value": { @@ -772,7 +839,7 @@ "base": null, "refs": { "DimensionValues$Values": "The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute, Amazon Elasticsearch Service, Amazon ElastiCache, Amazon Redshift, and Amazon Relational Database Service.
The specific value of a tag.
" + "TagValues$Values": "The specific value of the tag.
" } }, "YearMonthDay": { diff --git a/models/apis/mediatailor/2018-04-23/api-2.json b/models/apis/mediatailor/2018-04-23/api-2.json index a1bbe64d89f..1e69b099cea 100644 --- a/models/apis/mediatailor/2018-04-23/api-2.json +++ b/models/apis/mediatailor/2018-04-23/api-2.json @@ -95,6 +95,17 @@ "members" : { "ManifestEndpointPrefix" : { "shape" : "__string" + }, + "MpdLocation" : { + "shape" : "__string" + } + } + }, + "DashConfigurationForPut" : { + "type" : "structure", + "members" : { + "MpdLocation" : { + "shape" : "__string" } } }, @@ -210,6 +221,9 @@ "CdnConfiguration" : { "shape" : "CdnConfiguration" }, + "DashConfiguration" : { + "shape" : "DashConfigurationForPut" + }, "Name" : { "shape" : "__string" }, diff --git a/models/apis/mediatailor/2018-04-23/docs-2.json b/models/apis/mediatailor/2018-04-23/docs-2.json index 5bf5a5c7419..e8904cd206a 100644 --- a/models/apis/mediatailor/2018-04-23/docs-2.json +++ b/models/apis/mediatailor/2018-04-23/docs-2.json @@ -56,6 +56,7 @@ "CdnConfiguration$AdSegmentUrlPrefix" : "A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the following origin: ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
", "CdnConfiguration$ContentSegmentUrlPrefix" : "A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
", "DashConfiguration$ManifestEndpointPrefix" : "The URL that is used to initiate a playback session for devices that support DASH.
", + "DashConfiguration$MpdLocation" : "The setting that controls whether MediaTailor includes the Location tag in DASH Manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
", "GetPlaybackConfigurationResponse$AdDecisionServerUrl" : "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25000 characters.
", "GetPlaybackConfigurationResponse$Name" : "The identifier for the configuration.
", "GetPlaybackConfigurationResponse$PlaybackEndpointPrefix" : "The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
", diff --git a/models/apis/mq/2017-11-27/api-2.json b/models/apis/mq/2017-11-27/api-2.json index a518f415493..d31a54e7165 100644 --- a/models/apis/mq/2017-11-27/api-2.json +++ b/models/apis/mq/2017-11-27/api-2.json @@ -1,13 +1,13 @@ { "metadata" : { "apiVersion" : "2017-11-27", - "endpointPrefix" : "mq", + "endpointPrefix": "mq", "signingName" : "mq", - "serviceFullName" : "AmazonMQ", - "serviceId" : "mq", + "serviceFullName": "AmazonMQ", + "serviceId": "mq", "protocol" : "rest-json", "jsonVersion" : "1.1", - "uid" : "mq-2017-11-27", + "uid": "mq-2017-11-27", "signatureVersion" : "v4" }, "operations" : { @@ -56,6 +56,31 @@ }, { "shape" : "ConflictException" }, { + "shape": "ForbiddenException" + } + ] + }, + "CreateTags": { + "name": "CreateTags", + "http": { + "method": "POST", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "CreateTagsRequest" + }, + "errors": [ + { + "shape": "NotFoundException" + }, + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { "shape" : "ForbiddenException" } ] }, @@ -97,6 +122,31 @@ "output" : { "shape" : "DeleteBrokerResponse" }, + "errors": [ + { + "shape": "NotFoundException" + }, + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + } + ] + }, + "DeleteTags": { + "name": "DeleteTags", + "http": { + "method": "DELETE", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteTagsRequest" + }, "errors" : [ { "shape" : "NotFoundException" }, { @@ -287,6 +337,34 @@ "shape" : "ForbiddenException" } ] }, + "ListTags": { + "name": "ListTags", + "http": { + "method": "GET", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsRequest" + }, + "output": { + "shape": "ListTagsResponse" + }, + "errors": [ + { + "shape": "NotFoundException" + }, + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + } + ] + }, "ListUsers" : { "name" : "ListUsers", "http" : { @@ -519,6 +597,10 @@ "Name" : { "shape" : "__string", "locationName" : "name" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" } } }, @@ -642,6 +724,10 @@ "shape" : "__listOf__string", "locationName" : "subnetIds" }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" + }, "Users" : { "shape" : "__listOfUser", "locationName" : "users" @@ -717,6 +803,10 @@ "shape" : "__listOf__string", "locationName" : "subnetIds" }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" + }, "Users" : { "shape" : "__listOfUser", "locationName" : "users" @@ -750,6 +840,10 @@ "Name" : { "shape" : "__string", "locationName" : "name" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" } } }, @@ -792,6 +886,10 @@ "Name" : { "shape" : "__string", "locationName" : "name" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" } } }, @@ -820,6 +918,23 @@ } } }, + "CreateTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" + } + }, + "required": [ + "ResourceArn" + ] + }, "CreateUserInput" : { "type" : "structure", "members" : { @@ -902,6 +1017,25 @@ } } }, + "DeleteTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "shape": "__listOf__string", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + }, "DeleteUserRequest" : { "type" : "structure", "members" : { @@ -1001,6 +1135,10 @@ "shape" : "__listOf__string", "locationName" : "subnetIds" }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" + }, "Users" : { "shape" : "__listOfUserSummary", "locationName" : "users" @@ -1093,6 +1231,10 @@ "shape" : "__listOf__string", "locationName" : "subnetIds" }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" + }, "Users" : { "shape" : "__listOfUserSummary", "locationName" : "users" @@ -1144,6 +1286,10 @@ "Name" : { "shape" : "__string", "locationName" : "name" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" } } }, @@ -1475,6 +1621,28 @@ } } }, + "ListTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "ListTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" + } + } + }, "ListUsersOutput" : { "type" : "structure", "members" : { @@ -1647,6 +1815,15 @@ "type" : "string", "enum" : [ "DISALLOWED_ELEMENT_REMOVED", "DISALLOWED_ATTRIBUTE_REMOVED", "INVALID_ATTRIBUTE_VALUE_REMOVED" ] }, + "Tags": { + "type": "structure", + "members": { + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags" + } + } + }, "UnauthorizedException" : { "type" : "structure", "members" : { @@ -2040,6 +2217,15 @@ "__long" : { "type" : "long" }, + "__mapOf__string": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__string" + } + }, "__string" : { "type" : "string" }, @@ -2052,4 +2238,4 @@ "timestampFormat" : "unixTimestamp" } } -} +} \ No newline at end of file diff --git a/models/apis/mq/2017-11-27/docs-2.json b/models/apis/mq/2017-11-27/docs-2.json index b5f91c9edc6..79360e0fcb8 100644 --- a/models/apis/mq/2017-11-27/docs-2.json +++ b/models/apis/mq/2017-11-27/docs-2.json @@ -4,8 +4,10 @@ "operations" : { "CreateBroker" : "Creates a broker. Note: This API is asynchronous.", "CreateConfiguration" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).", + "CreateTags": "Add a tag to a resource.", "CreateUser" : "Creates an ActiveMQ user.", "DeleteBroker" : "Deletes a broker. Note: This API is asynchronous.", + "DeleteTags": "Remove a tag from a resource.", "DeleteUser" : "Deletes an ActiveMQ user.", "DescribeBroker" : "Returns information about the specified broker.", "DescribeConfiguration" : "Returns information about the specified configuration.", @@ -14,6 +16,7 @@ "ListBrokers" : "Returns a list of all brokers.", "ListConfigurationRevisions" : "Returns a list of all revisions for the specified configuration.", "ListConfigurations" : "Returns a list of all configurations.", + "ListTags": "Lists tags for a resource.", "ListUsers" : "Returns a list of all ActiveMQ users.", "RebootBroker" : "Reboots a broker. Note: This API is asynchronous.", "UpdateBroker" : "Adds a pending configuration change to a broker.", @@ -126,7 +129,7 @@ } }, "DescribeBrokerOutput" : { - "base" : "The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.", + "base": "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "refs" : { } }, "DescribeConfigurationRevisionOutput" : { @@ -206,10 +209,14 @@ }, "SanitizationWarningReason" : { "base" : "The reason for which the XML elements or attributes were sanitized.", - "refs" : { - "SanitizationWarning$Reason" : "Required. The reason for which the XML elements or attributes were sanitized." + "refs": { + "SanitizationWarning$Reason": "Required. The reason for which the XML elements or attributes were sanitized." } }, + "Tags": { + "base": "A map of the key-value pairs for the resource tag.", + "refs": {} + }, "UnauthorizedException" : { "base" : "Returns information about an error.", "refs" : { } @@ -360,6 +367,16 @@ "UserPendingChanges$Groups" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." } }, + "__mapOf__string": { + "base": null, + "refs": { + "Configuration$Tags": "The list of all tags associated with this configuration.", + "CreateBrokerInput$Tags": "Create tags when creating the broker.", + "CreateConfigurationInput$Tags": "Create tags when creating the configuration.", + "DescribeBrokerOutput$Tags": "The list of all tags associated with this broker.", + "Tags$Tags": "The key-value pair for the resource tag." + } + }, "__string" : { "base" : null, "refs" : { @@ -371,18 +388,18 @@ "BrokerSummary$HostInstanceType" : "The broker's instance type.", "Configuration$Arn" : "Required. The ARN of the configuration.", "Configuration$Description" : "Required. The description of the configuration.", - "Configuration$EngineVersion" : "Required. The version of the broker engine.", + "Configuration$EngineVersion": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "Configuration$Id" : "Required. The unique ID that Amazon MQ generates for the configuration.", "Configuration$Name" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", "ConfigurationId$Id" : "Required. The unique ID that Amazon MQ generates for the configuration.", "ConfigurationRevision$Description" : "The description of the configuration revision.", "CreateBrokerInput$BrokerName" : "Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.", "CreateBrokerInput$CreatorRequestId" : "The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.", - "CreateBrokerInput$EngineVersion" : "Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.", + "CreateBrokerInput$EngineVersion": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "CreateBrokerInput$HostInstanceType" : "Required. The broker's instance type.", "CreateBrokerOutput$BrokerArn" : "The Amazon Resource Name (ARN) of the broker.", "CreateBrokerOutput$BrokerId" : "The unique ID that Amazon MQ generates for the broker.", - "CreateConfigurationInput$EngineVersion" : "Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.", + "CreateConfigurationInput$EngineVersion": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "CreateConfigurationInput$Name" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", "CreateConfigurationOutput$Arn" : "Required. The Amazon Resource Name (ARN) of the configuration.", "CreateConfigurationOutput$Id" : "Required. The unique ID that Amazon MQ generates for the configuration.", @@ -392,9 +409,9 @@ "DescribeBrokerOutput$BrokerArn" : "The Amazon Resource Name (ARN) of the broker.", "DescribeBrokerOutput$BrokerId" : "The unique ID that Amazon MQ generates for the broker.", "DescribeBrokerOutput$BrokerName" : "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.", - "DescribeBrokerOutput$EngineVersion" : "The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.", + "DescribeBrokerOutput$EngineVersion": "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "DescribeBrokerOutput$HostInstanceType" : "The broker's instance type.", - "DescribeBrokerOutput$PendingEngineVersion" : "The version of the broker engine to upgrade to.", + "DescribeBrokerOutput$PendingEngineVersion": "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "DescribeConfigurationRevisionOutput$ConfigurationId" : "Required. The unique ID that Amazon MQ generates for the configuration.", "DescribeConfigurationRevisionOutput$Data" : "Required. The base64-encoded XML configuration.", "DescribeConfigurationRevisionOutput$Description" : "The description of the configuration.", @@ -412,9 +429,9 @@ "LogsSummary$GeneralLogGroup" : "The location of the CloudWatch Logs log group where general logs are sent.", "SanitizationWarning$AttributeName" : "The name of the XML attribute that has been sanitized.", "SanitizationWarning$ElementName" : "The name of the XML element that has been sanitized.", - "UpdateBrokerInput$EngineVersion" : "The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.", + "UpdateBrokerInput$EngineVersion": "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "UpdateBrokerOutput$BrokerId" : "Required. The unique ID that Amazon MQ generates for the broker.", - "UpdateBrokerOutput$EngineVersion" : "The version of the broker engine to upgrade to.", + "UpdateBrokerOutput$EngineVersion": "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", "UpdateConfigurationInput$Data" : "Required. The base64-encoded XML configuration.", "UpdateConfigurationInput$Description" : "The description of the configuration.", "UpdateConfigurationOutput$Arn" : "Required. The Amazon Resource Name (ARN) of the configuration.", @@ -426,7 +443,8 @@ "UserSummary$Username" : "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", "WeeklyStartTime$TimeOfDay" : "Required. The time, in 24-hour format.", "WeeklyStartTime$TimeZone" : "The time zone, UTC by default, in either the Country/City format, or the UTC offset format.", - "__listOf__string$member" : null + "__listOf__string$member": null, + "__mapOf__string$member": null } }, "__timestampIso8601" : { diff --git a/service/costexplorer/api.go b/service/costexplorer/api.go index ce52f56aa27..9cebdb81437 100644 --- a/service/costexplorer/api.go +++ b/service/costexplorer/api.go @@ -326,8 +326,8 @@ func (c *CostExplorer) GetReservationCoverageRequest(input *GetReservationCovera // GetReservationCoverage API operation for AWS Cost Explorer Service. // -// Retrieves the reservation coverage for your account. This allows you to see -// how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon +// Retrieves the reservation coverage for your account. This enables you to +// see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon // Relational Database Service, or Amazon Redshift usage is covered by a reservation. // An organization's master account can see the coverage of the associated member // accounts. For any time period, you can filter data about reservation usage @@ -452,13 +452,13 @@ func (c *CostExplorer) GetReservationPurchaseRecommendationRequest(input *GetRes // every combination of reservations in each category of usage to identify the // best number of each type of RI to purchase to maximize your estimated savings. // -// For example, AWS automatically aggregates your EC2 Linux, shared tenancy, +// For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, // and c4 family usage in the US West (Oregon) Region and recommends that you // buy size-flexible regional reservations to apply to the c4 family usage. // AWS recommends the smallest size instance in an instance family. This makes // it easier to purchase a size-flexible RI. AWS also shows the equal number // of normalized units so that you can purchase any instance size that you want. -// For this example, your RI recommendation would be for c4.large, because that +// For this example, your RI recommendation would be for c4.large because that // is the smallest size instance in the c4 instance family. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -685,8 +685,15 @@ func (c *CostExplorer) GetTagsWithContext(ctx aws.Context, input *GetTagsInput, type Coverage struct { _ struct{} `type:"structure"` - // The amount of instance usage that a reservation covered, in hours. + // The amount of cost that the reservation covered. + CoverageCost *CoverageCost `type:"structure"` + + // The amount of instance usage that the reservation covered, in hours. CoverageHours *CoverageHours `type:"structure"` + + // The amount of instance usage that the reservation covered, in normalized + // units. + CoverageNormalizedUnits *CoverageNormalizedUnits `type:"structure"` } // String returns the string representation @@ -699,20 +706,32 @@ func (s Coverage) GoString() string { return s.String() } +// SetCoverageCost sets the CoverageCost field's value. +func (s *Coverage) SetCoverageCost(v *CoverageCost) *Coverage { + s.CoverageCost = v + return s +} + // SetCoverageHours sets the CoverageHours field's value. func (s *Coverage) SetCoverageHours(v *CoverageHours) *Coverage { s.CoverageHours = v return s } +// SetCoverageNormalizedUnits sets the CoverageNormalizedUnits field's value. +func (s *Coverage) SetCoverageNormalizedUnits(v *CoverageNormalizedUnits) *Coverage { + s.CoverageNormalizedUnits = v + return s +} + // Reservation coverage for a specified period, in hours. type CoverageByTime struct { _ struct{} `type:"structure"` - // The groups of instances that are covered by a reservation. + // The groups of instances that the reservation covered. Groups []*ReservationCoverageGroup `type:"list"` - // The period over which this coverage was used. + // The period that this coverage was used over. TimePeriod *DateInterval `type:"structure"` // The total reservation coverage, in hours. @@ -747,17 +766,41 @@ func (s *CoverageByTime) SetTotal(v *Coverage) *CoverageByTime { return s } +// How much it cost to run an instance. +type CoverageCost struct { + _ struct{} `type:"structure"` + + // How much an On-Demand instance cost. + OnDemandCost *string `type:"string"` +} + +// String returns the string representation +func (s CoverageCost) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CoverageCost) GoString() string { + return s.String() +} + +// SetOnDemandCost sets the OnDemandCost field's value. +func (s *CoverageCost) SetOnDemandCost(v string) *CoverageCost { + s.OnDemandCost = &v + return s +} + // How long a running instance either used a reservation or was On-Demand. type CoverageHours struct { _ struct{} `type:"structure"` - // The percentage of instance hours that are covered by a reservation. + // The percentage of instance hours that a reservation covered. CoverageHoursPercentage *string `type:"string"` - // The number of instance running hours that are covered by On-Demand Instances. + // The number of instance running hours that On-Demand Instances covered. OnDemandHours *string `type:"string"` - // The number of instance running hours that are covered by reservations. + // The number of instance running hours that reservations covered. ReservedHours *string `type:"string"` // The total instance usage, in hours. @@ -798,6 +841,69 @@ func (s *CoverageHours) SetTotalRunningHours(v string) *CoverageHours { return s } +// The amount of instance usage, in normalized units. Normalized units enable +// you to see your EC2 usage for multiple sizes of instances in a uniform way. +// For example, suppose you run an xlarge instance and a 2xlarge instance. If +// you run both instances for the same amount of time, the 2xlarge instance +// uses twice as much of your reservation as the xlarge instance, even though +// both instances show only one instance-hour. Using normalized units instead +// of instance-hours, the xlarge instance used 8 normalized units, and the 2xlarge +// instance used 16 normalized units. +// +// For more information, see Modifying Reserved Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) +// in the Amazon Elastic Compute Cloud User Guide for Linux Instances. +type CoverageNormalizedUnits struct { + _ struct{} `type:"structure"` + + // The percentage of your used instance normalized units that a reservation + // covers. + CoverageNormalizedUnitsPercentage *string `type:"string"` + + // The number of normalized units that are covered by On-Demand Instances instead + // of a reservation. + OnDemandNormalizedUnits *string `type:"string"` + + // The number of normalized units that a reservation covers. + ReservedNormalizedUnits *string `type:"string"` + + // The total number of normalized units that you used. + TotalRunningNormalizedUnits *string `type:"string"` +} + +// String returns the string representation +func (s CoverageNormalizedUnits) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CoverageNormalizedUnits) GoString() string { + return s.String() +} + +// SetCoverageNormalizedUnitsPercentage sets the CoverageNormalizedUnitsPercentage field's value. +func (s *CoverageNormalizedUnits) SetCoverageNormalizedUnitsPercentage(v string) *CoverageNormalizedUnits { + s.CoverageNormalizedUnitsPercentage = &v + return s +} + +// SetOnDemandNormalizedUnits sets the OnDemandNormalizedUnits field's value. +func (s *CoverageNormalizedUnits) SetOnDemandNormalizedUnits(v string) *CoverageNormalizedUnits { + s.OnDemandNormalizedUnits = &v + return s +} + +// SetReservedNormalizedUnits sets the ReservedNormalizedUnits field's value. +func (s *CoverageNormalizedUnits) SetReservedNormalizedUnits(v string) *CoverageNormalizedUnits { + s.ReservedNormalizedUnits = &v + return s +} + +// SetTotalRunningNormalizedUnits sets the TotalRunningNormalizedUnits field's value. +func (s *CoverageNormalizedUnits) SetTotalRunningNormalizedUnits(v string) *CoverageNormalizedUnits { + s.TotalRunningNormalizedUnits = &v + return s +} + // The time period that you want the usage and costs for. type DateInterval struct { _ struct{} `type:"structure"` @@ -929,14 +1035,14 @@ func (s *DimensionValuesWithAttributes) SetValue(v string) *DimensionValuesWithA return s } -// Details about the EC2 instances that AWS recommends that you purchase. +// Details about the Amazon EC2 instances that AWS recommends that you purchase. type EC2InstanceDetails struct { _ struct{} `type:"structure"` // The Availability Zone of the recommended reservation. AvailabilityZone *string `type:"string"` - // Whether the recommendation is for a current generation instance. + // Whether the recommendation is for a current-generation instance. CurrentGeneration *bool `type:"boolean"` // The instance family of the recommended reservation. @@ -1017,7 +1123,7 @@ func (s *EC2InstanceDetails) SetTenancy(v string) *EC2InstanceDetails { return s } -// The EC2 hardware specifications that you want AWS to provide recommendations +// The Amazon EC2 hardware specifications that you want AWS to provide recommendations // for. type EC2Specification struct { _ struct{} `type:"structure"` @@ -1042,11 +1148,11 @@ func (s *EC2Specification) SetOfferingClass(v string) *EC2Specification { return s } -// Details about the ES instances that AWS recommends that you purchase. +// Details about the Amazon ES instances that AWS recommends that you purchase. type ESInstanceDetails struct { _ struct{} `type:"structure"` - // Whether the recommendation is for a current generation instance. + // Whether the recommendation is for a current-generation instance. CurrentGeneration *bool `type:"boolean"` // The class of instance that AWS recommends. @@ -1102,7 +1208,8 @@ func (s *ESInstanceDetails) SetSizeFlexEligible(v bool) *ESInstanceDetails { return s } -// Details about the ElastiCache instances that AWS recommends that you purchase. +// Details about the Amazon ElastiCache instances that AWS recommends that you +// purchase. type ElastiCacheInstanceDetails struct { _ struct{} `type:"structure"` @@ -1324,6 +1431,8 @@ type GetCostAndUsageInput struct { // Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, // the response object doesn't include the Granularity, either MONTHLY or DAILY. + // + // The GetCostAndUsageRequest operation supports only DAILY and MONTHLY granularities. Granularity *string `type:"string" enum:"Granularity"` // You can group AWS costs using up to two different groups, either dimensions, @@ -1344,10 +1453,10 @@ type GetCostAndUsageInput struct { // // If you return the UsageQuantity metric, the service aggregates all usage // numbers without taking into account the units. For example, if you aggregate - // usageQuantity across all of EC2, the results aren't meaningful because EC2 - // compute hours and data transfer are measured in different units (for example, - // hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType - // or UsageTypeGroups. + // usageQuantity across all of Amazon EC2, the results aren't meaningful because + // Amazon EC2 compute hours and data transfer are measured in different units + // (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, + // filter by UsageType or UsageTypeGroups. // // Metrics is required for GetCostAndUsage requests. Metrics []*string `type:"list"` @@ -1479,6 +1588,8 @@ type GetCostForecastInput struct { // How granular you want the forecast to be. You can get 3 months of DAILY forecasts // or 12 months of MONTHLY forecasts. // + // The GetCostForecast operation supports only DAILY and MONTHLY granularities. + // // Granularity is a required field Granularity *string `type:"string" required:"true" enum:"Granularity"` @@ -1620,7 +1731,7 @@ type GetDimensionValuesInput struct { // The context for the call to GetDimensionValues. This can be RESERVATIONS // or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is // set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization - // operation. If the context is set to COST_AND_USAGE the resulting dimension + // operation. If the context is set to COST_AND_USAGE, the resulting dimension // values can be used in the GetCostAndUsage operation. // // If you set the context to COST_AND_USAGE, you can use the following dimensions @@ -1631,7 +1742,7 @@ type GetDimensionValuesInput struct { // * DATABASE_ENGINE - The Amazon Relational Database Service database. Examples // are Aurora or MySQL. // - // * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge. + // * INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. // // * LEGAL_ENTITY_NAME - The name of the organization that sells you AWS // services, such as Amazon Web Services. @@ -1644,7 +1755,8 @@ type GetDimensionValuesInput struct { // // * OPERATION - The action performed. Examples include RunInstance and CreateBucket. // - // * PLATFORM - The EC2 operating system. Examples are Windows or Linux. + // * PLATFORM - The Amazon EC2 operating system. Examples are Windows or + // Linux. // // * PURCHASE_TYPE - The reservation type of the purchase to which this usage // is related. Examples include On-Demand Instances and Standard Reserved @@ -1657,8 +1769,8 @@ type GetDimensionValuesInput struct { // Examples include GB and Hrs. // // * USAGE_TYPE_GROUP - The grouping of common usage types. An example is - // EC2: CloudWatch – Alarms. The response for this operation includes a unit - // attribute. + // Amazon EC2: CloudWatch – Alarms. The response for this operation includes + // a unit attribute. // // * RECORD_TYPE - The different types of charges such as RI fees, usage // costs, tax refunds, and credits. @@ -1674,13 +1786,14 @@ type GetDimensionValuesInput struct { // * DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service // deployments. Valid values are SingleAZ and MultiAZ. // - // * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge. + // * INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. // // * LINKED_ACCOUNT - The description in the attribute map that includes // the full name of the member account. The value field contains the AWS // ID of the member account. // - // * PLATFORM - The EC2 operating system. Examples are Windows or Linux. + // * PLATFORM - The Amazon EC2 operating system. Examples are Windows or + // Linux. // // * REGION - The AWS Region. // @@ -1693,7 +1806,7 @@ type GetDimensionValuesInput struct { // * TENANCY - The tenancy of a resource. Examples are shared or dedicated. Context *string `type:"string" enum:"Context"` - // The name of the dimension. Each Dimension is available for different a Context. + // The name of the dimension. Each Dimension is available for a different Context. // For more information, see Context. // // Dimension is a required field @@ -1781,7 +1894,7 @@ type GetDimensionValuesOutput struct { _ struct{} `type:"structure"` // The filters that you used to filter your request. Some dimensions are available - // only for a specific context: + // only for a specific context. // // If you set the context to COST_AND_USAGE, you can use the following dimensions // for searching: @@ -1791,7 +1904,7 @@ type GetDimensionValuesOutput struct { // * DATABASE_ENGINE - The Amazon Relational Database Service database. Examples // are Aurora or MySQL. // - // * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge. + // * INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. // // * LEGAL_ENTITY_NAME - The name of the organization that sells you AWS // services, such as Amazon Web Services. @@ -1804,7 +1917,8 @@ type GetDimensionValuesOutput struct { // // * OPERATION - The action performed. Examples include RunInstance and CreateBucket. // - // * PLATFORM - The EC2 operating system. Examples are Windows or Linux. + // * PLATFORM - The Amazon EC2 operating system. Examples are Windows or + // Linux. // // * PURCHASE_TYPE - The reservation type of the purchase to which this usage // is related. Examples include On-Demand Instances and Standard Reserved @@ -1817,8 +1931,8 @@ type GetDimensionValuesOutput struct { // Examples include GB and Hrs. // // * USAGE_TYPE_GROUP - The grouping of common usage types. An example is - // EC2: CloudWatch – Alarms. The response for this operation includes a unit - // attribute. + // Amazon EC2: CloudWatch – Alarms. The response for this operation includes + // a unit attribute. // // * RECORD_TYPE - The different types of charges such as RI fees, usage // costs, tax refunds, and credits. @@ -1834,13 +1948,14 @@ type GetDimensionValuesOutput struct { // * DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service // deployments. Valid values are SingleAZ and MultiAZ. // - // * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge. + // * INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. // // * LINKED_ACCOUNT - The description in the attribute map that includes // the full name of the member account. The value field contains the AWS // ID of the member account. // - // * PLATFORM - The EC2 operating system. Examples are Windows or Linux. + // * PLATFORM - The Amazon EC2 operating system. Examples are Windows or + // Linux. // // * REGION - The AWS Region. // @@ -1906,7 +2021,7 @@ func (s *GetDimensionValuesOutput) SetTotalSize(v int64) *GetDimensionValuesOutp } // You can use the following request parameters to query for how much of your -// instance usage is covered by a reservation. +// instance usage a reservation covered. type GetReservationCoverageInput struct { _ struct{} `type:"structure"` @@ -1949,6 +2064,8 @@ type GetReservationCoverageInput struct { // // If GroupBy is set, Granularity can't be set. If Granularity isn't set, the // response object doesn't include Granularity, either MONTHLY or DAILY. + // + // The GetReservationCoverage operation supports only DAILY and MONTHLY granularities. Granularity *string `type:"string" enum:"Granularity"` // You can group the data by the following attributes: @@ -1976,13 +2093,15 @@ type GetReservationCoverageInput struct { // * TENANCY GroupBy []*GroupDefinition `type:"list"` + Metrics []*string `type:"list"` + // The token to retrieve the next set of results. AWS provides the token when // the response from a previous call has more results than the maximum page // size. NextPageToken *string `type:"string"` - // The start and end dates of the period for which you want to retrieve data - // about reservation coverage. You can retrieve data for a maximum of 13 months: + // The start and end dates of the period that you want to retrieve data about + // reservation coverage for. You can retrieve data for a maximum of 13 months: // the last 12 months and the current month. The start date is inclusive, but // the end date is exclusive. For example, if start is 2017-01-01 and end is // 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up @@ -2038,6 +2157,12 @@ func (s *GetReservationCoverageInput) SetGroupBy(v []*GroupDefinition) *GetReser return s } +// SetMetrics sets the Metrics field's value. +func (s *GetReservationCoverageInput) SetMetrics(v []*string) *GetReservationCoverageInput { + s.Metrics = v + return s +} + // SetNextPageToken sets the NextPageToken field's value. func (s *GetReservationCoverageInput) SetNextPageToken(v string) *GetReservationCoverageInput { s.NextPageToken = &v @@ -2063,7 +2188,7 @@ type GetReservationCoverageOutput struct { // page size. NextPageToken *string `type:"string"` - // The total amount of instance usage that is covered by a reservation. + // The total amount of instance usage that a reservation covered. Total *Coverage `type:"structure"` } @@ -2130,7 +2255,7 @@ type GetReservationPurchaseRecommendationInput struct { Service *string `type:"string" required:"true"` // The hardware specifications for the service instances that you want recommendations - // for, such as standard or convertible EC2 instances. + // for, such as standard or convertible Amazon EC2 instances. ServiceSpecification *ServiceSpecification `type:"structure"` // The reservation term that you want recommendations for. @@ -2295,6 +2420,8 @@ type GetReservationUtilizationInput struct { // response object doesn't include Granularity, either MONTHLY or DAILY. If // both GroupBy and Granularity aren't set, GetReservationUtilization defaults // to DAILY. + // + // The GetReservationUtilization operation supports only DAILY and MONTHLY granularities. Granularity *string `type:"string" enum:"Granularity"` // Groups only by SUBSCRIPTION_ID. Metadata is included. @@ -2305,11 +2432,10 @@ type GetReservationUtilizationInput struct { // size. NextPageToken *string `type:"string"` - // Sets the start and end dates for retrieving Reserved Instance (RI) utilization. - // The start date is inclusive, but the end date is exclusive. For example, - // if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data - // is retrieved from 2017-01-01 up to and including 2017-04-30 but not including - // 2017-05-01. + // Sets the start and end dates for retrieving RI utilization. The start date + // is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 + // and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 + // up to and including 2017-04-30 but not including 2017-05-01. // // TimePeriod is a required field TimePeriod *DateInterval `type:"structure" required:"true"` @@ -2381,10 +2507,10 @@ type GetReservationUtilizationOutput struct { // page size. NextPageToken *string `type:"string"` - // The total amount of time that you utilized your RIs. + // The total amount of time that you used your RIs. Total *ReservationAggregates `type:"structure"` - // The amount of time that you utilized your RIs. + // The amount of time that you used your RIs. // // UtilizationsByTime is a required field UtilizationsByTime []*UtilizationByTime `type:"list" required:"true"` @@ -2551,7 +2677,7 @@ func (s *GetTagsOutput) SetTotalSize(v int64) *GetTagsOutput { return s } -// One level of grouped data within the results. +// One level of grouped data in the results. type Group struct { _ struct{} `type:"structure"` @@ -2584,7 +2710,7 @@ func (s *Group) SetMetrics(v map[string]*MetricValue) *Group { return s } -// Represents a group when you specify a group by criteria, or in the response +// Represents a group when you specify a group by criteria or in the response // to a query with a specific grouping. type GroupDefinition struct { _ struct{} `type:"structure"` @@ -2622,7 +2748,7 @@ func (s *GroupDefinition) SetType(v string) *GroupDefinition { type InstanceDetails struct { _ struct{} `type:"structure"` - // The EC2 instances that AWS recommends that you purchase. + // The Amazon EC2 instances that AWS recommends that you purchase. EC2InstanceDetails *EC2InstanceDetails `type:"structure"` // The Amazon ES instances that AWS recommends that you purchase. @@ -2631,7 +2757,7 @@ type InstanceDetails struct { // The ElastiCache instances that AWS recommends that you purchase. ElastiCacheInstanceDetails *ElastiCacheInstanceDetails `type:"structure"` - // The RDS instances that AWS recommends that you purchase. + // The Amazon RDS instances that AWS recommends that you purchase. RDSInstanceDetails *RDSInstanceDetails `type:"structure"` // The Amazon Redshift instances that AWS recommends that you purchase. @@ -2711,11 +2837,11 @@ func (s *MetricValue) SetUnit(v string) *MetricValue { return s } -// Details about the RDS instances that AWS recommends that you purchase. +// Details about the Amazon RDS instances that AWS recommends that you purchase. type RDSInstanceDetails struct { _ struct{} `type:"structure"` - // Whether the recommendation is for a current generation instance. + // Whether the recommendation is for a current-generation instance. CurrentGeneration *bool `type:"boolean"` // The database edition that the recommended reservation supports. @@ -2813,7 +2939,7 @@ func (s *RDSInstanceDetails) SetSizeFlexEligible(v bool) *RDSInstanceDetails { type RedshiftInstanceDetails struct { _ struct{} `type:"structure"` - // Whether the recommendation is for a current generation instance. + // Whether the recommendation is for a current-generation instance. CurrentGeneration *bool `type:"boolean"` // The instance family of the recommended reservation. @@ -2869,40 +2995,60 @@ func (s *RedshiftInstanceDetails) SetSizeFlexEligible(v bool) *RedshiftInstanceD return s } -// The aggregated numbers for your Reserved Instance (RI) usage. +// The aggregated numbers for your reservation usage. type ReservationAggregates struct { _ struct{} `type:"structure"` - // The monthly cost of your RI, amortized over the RI period. + // The monthly cost of your reservation, amortized over the reservation period. AmortizedRecurringFee *string `type:"string"` - // The upfront cost of your RI, amortized over the RI period. + // The upfront cost of your reservation, amortized over the reservation period. AmortizedUpfrontFee *string `type:"string"` - // How much you saved due to purchasing and utilizing RIs. AWS calculates this - // by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed. + // How much you saved due to purchasing and utilizing reservation. AWS calculates + // this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed. NetRISavings *string `type:"string"` - // How much your RIs would cost if charged On-Demand rates. + // How much your reservation would cost if charged On-Demand rates. OnDemandCostOfRIHoursUsed *string `type:"string"` - // How many RI hours that you purchased. + // How many reservation hours that you purchased. PurchasedHours *string `type:"string"` - // The total number of RI hours that you used. + // How many Amazon EC2 reservation hours that you purchased, converted to normalized + // units. Normalized units are available only for Amazon EC2 usage after November + // 11, 2017. + PurchasedUnits *string `type:"string"` + + // The total number of reservation hours that you used. TotalActualHours *string `type:"string"` - // The total cost of your RI, amortized over the RI period. + // The total number of Amazon EC2 reservation hours that you used, converted + // to normalized units. Normalized units are available only for Amazon EC2 usage + // after November 11, 2017. + TotalActualUnits *string `type:"string"` + + // The total cost of your reservation, amortized over the reservation period. TotalAmortizedFee *string `type:"string"` // How much you could save if you use your entire reservation. TotalPotentialRISavings *string `type:"string"` - // The number of RI hours that you didn't use. + // The number of reservation hours that you didn't use. UnusedHours *string `type:"string"` - // The percentage of RI time that you used. + // The number of Amazon EC2 reservation hours that you didn't use, converted + // to normalized units. Normalized units are available only for Amazon EC2 usage + // after November 11, 2017. + UnusedUnits *string `type:"string"` + + // The percentage of reservation time that you used. UtilizationPercentage *string `type:"string"` + + // The percentage of Amazon EC2 reservation time that you used, converted to + // normalized units. Normalized units are available only for Amazon EC2 usage + // after November 11, 2017. + UtilizationPercentageInUnits *string `type:"string"` } // String returns the string representation @@ -2945,12 +3091,24 @@ func (s *ReservationAggregates) SetPurchasedHours(v string) *ReservationAggregat return s } +// SetPurchasedUnits sets the PurchasedUnits field's value. +func (s *ReservationAggregates) SetPurchasedUnits(v string) *ReservationAggregates { + s.PurchasedUnits = &v + return s +} + // SetTotalActualHours sets the TotalActualHours field's value. func (s *ReservationAggregates) SetTotalActualHours(v string) *ReservationAggregates { s.TotalActualHours = &v return s } +// SetTotalActualUnits sets the TotalActualUnits field's value. +func (s *ReservationAggregates) SetTotalActualUnits(v string) *ReservationAggregates { + s.TotalActualUnits = &v + return s +} + // SetTotalAmortizedFee sets the TotalAmortizedFee field's value. func (s *ReservationAggregates) SetTotalAmortizedFee(v string) *ReservationAggregates { s.TotalAmortizedFee = &v @@ -2969,12 +3127,24 @@ func (s *ReservationAggregates) SetUnusedHours(v string) *ReservationAggregates return s } +// SetUnusedUnits sets the UnusedUnits field's value. +func (s *ReservationAggregates) SetUnusedUnits(v string) *ReservationAggregates { + s.UnusedUnits = &v + return s +} + // SetUtilizationPercentage sets the UtilizationPercentage field's value. func (s *ReservationAggregates) SetUtilizationPercentage(v string) *ReservationAggregates { s.UtilizationPercentage = &v return s } +// SetUtilizationPercentageInUnits sets the UtilizationPercentageInUnits field's value. +func (s *ReservationAggregates) SetUtilizationPercentageInUnits(v string) *ReservationAggregates { + s.UtilizationPercentageInUnits = &v + return s +} + // A group of reservations that share a set of attributes. type ReservationCoverageGroup struct { _ struct{} `type:"structure"` @@ -3141,8 +3311,9 @@ type ReservationPurchaseRecommendationDetail struct { // period. AWS uses this to calculate your recommended reservation purchases. MaximumNumberOfInstancesUsedPerHour *string `type:"string"` - // The minimum number of hours that you used in an hour during the historical - // period. AWS uses this to calculate your recommended reservation purchases. + // The minimum number of normalized units that you used in an hour during the + // historical period. AWS uses this to calculate your recommended reservation + // purchases. MinimumNormalizedUnitsUsedPerHour *string `type:"string"` // The minimum number of instances that you used in an hour during the historical @@ -3366,20 +3537,20 @@ func (s *ReservationPurchaseRecommendationSummary) SetTotalEstimatedMonthlySavin return s } -// A group of Reserved Instances (RIs) that share a set of attributes. +// A group of reservations that share a set of attributes. type ReservationUtilizationGroup struct { _ struct{} `type:"structure"` - // The attributes for this group of RIs. + // The attributes for this group of reservations. Attributes map[string]*string `type:"map"` - // The key for a specific RI attribute. + // The key for a specific reservation attribute. Key *string `type:"string"` - // How much you used this group of RIs. + // How much you used this group of reservations. Utilization *ReservationAggregates `type:"structure"` - // The value of a specific RI attribute. + // The value of a specific reservation attribute. Value *string `type:"string"` } @@ -3421,13 +3592,13 @@ func (s *ReservationUtilizationGroup) SetValue(v string) *ReservationUtilization type ResultByTime struct { _ struct{} `type:"structure"` - // Whether this result is estimated. + // Whether the result is estimated. Estimated *bool `type:"boolean"` - // The groups that are included in this time period. + // The groups that this time period includes. Groups []*Group `type:"list"` - // The time period covered by a result. + // The time period that the result covers. TimePeriod *DateInterval `type:"structure"` // The total amount of cost or usage accrued during the time period. @@ -3472,7 +3643,7 @@ func (s *ResultByTime) SetTotal(v map[string]*MetricValue) *ResultByTime { type ServiceSpecification struct { _ struct{} `type:"structure"` - // The EC2 hardware specifications that you want AWS to provide recommendations + // The Amazon EC2 hardware specifications that you want AWS to provide recommendations // for. EC2Specification *EC2Specification `type:"structure"` } @@ -3497,10 +3668,10 @@ func (s *ServiceSpecification) SetEC2Specification(v *EC2Specification) *Service type TagValues struct { _ struct{} `type:"structure"` - // The key for a tag. + // The key for the tag. Key *string `type:"string"` - // The specific value of a tag. + // The specific value of the tag. Values []*string `type:"list"` } @@ -3530,13 +3701,13 @@ func (s *TagValues) SetValues(v []*string) *TagValues { type UtilizationByTime struct { _ struct{} `type:"structure"` - // The groups that are included in this utilization result. + // The groups that this utilization result uses. Groups []*ReservationUtilizationGroup `type:"list"` - // The period of time over which this utilization was used. + // The period of time that this utilization was used for. TimePeriod *DateInterval `type:"structure"` - // The total number of RI hours that were used. + // The total number of reservation hours that were used. Total *ReservationAggregates `type:"structure"` } diff --git a/service/costexplorer/doc.go b/service/costexplorer/doc.go index 954e17d6274..45d4cae2aca 100644 --- a/service/costexplorer/doc.go +++ b/service/costexplorer/doc.go @@ -3,7 +3,7 @@ // Package costexplorer provides the client and types for making API // requests to AWS Cost Explorer Service. // -// The Cost Explorer API allows you to programmatically query your cost and +// The Cost Explorer API enables you to programmatically query your cost and // usage data. You can query for aggregated data such as total monthly costs // or total daily usage. You can also query for granular data, such as the number // of daily write operations for Amazon DynamoDB database tables in your production diff --git a/service/elasticache/examples_test.go b/service/elasticache/examples_test.go index af0738bd720..2579113d104 100644 --- a/service/elasticache/examples_test.go +++ b/service/elasticache/examples_test.go @@ -220,14 +220,14 @@ func ExampleElastiCache_CreateCacheCluster_shared00() { func ExampleElastiCache_CreateCacheCluster_shared01() { svc := elasticache.New(session.New()) input := &elasticache.CreateCacheClusterInput{ - AutoMinorVersionUpgrade: aws.Bool(true), - CacheClusterId: aws.String("my-redis"), - CacheNodeType: aws.String("cache.r3.larage"), - CacheSubnetGroupName: aws.String("default"), - Engine: aws.String("redis"), - EngineVersion: aws.String("3.2.4"), - NumCacheNodes: aws.Int64(1), - Port: aws.Int64(6379), + AutoMinorVersionUpgrade: aws.Bool(true), + CacheClusterId: aws.String("my-redis"), + CacheNodeType: aws.String("cache.r3.larage"), + CacheSubnetGroupName: aws.String("default"), + Engine: aws.String("redis"), + EngineVersion: aws.String("3.2.4"), + NumCacheNodes: aws.Int64(1), + Port: aws.Int64(6379), PreferredAvailabilityZone: aws.String("us-east-1c"), SnapshotRetentionLimit: aws.Int64(7), } diff --git a/service/iam/examples_test.go b/service/iam/examples_test.go index 66c36f93edd..e2898a1a9f8 100644 --- a/service/iam/examples_test.go +++ b/service/iam/examples_test.go @@ -520,8 +520,8 @@ func ExampleIAM_CreateRole_shared00() { svc := iam.New(session.New()) input := &iam.CreateRoleInput{ AssumeRolePolicyDocument: aws.String("