UNPKG

cloudworker-proxy

Version:
1,367 lines 35 kB
{ "version": "2.0", "metadata": { "apiVersion": "2017-10-25", "endpointPrefix": "ce", "jsonVersion": "1.1", "protocol": "json", "serviceAbbreviation": "AWS Cost Explorer", "serviceFullName": "AWS Cost Explorer Service", "serviceId": "Cost Explorer", "signatureVersion": "v4", "signingName": "ce", "targetPrefix": "AWSInsightsIndexService", "uid": "ce-2017-10-25" }, "operations": { "CreateCostCategoryDefinition": { "input": { "type": "structure", "required": [ "Name", "RuleVersion", "Rules" ], "members": { "Name": {}, "RuleVersion": {}, "Rules": { "shape": "S4" } } }, "output": { "type": "structure", "members": { "CostCategoryArn": {}, "EffectiveStart": {} } } }, "DeleteCostCategoryDefinition": { "input": { "type": "structure", "required": [ "CostCategoryArn" ], "members": { "CostCategoryArn": {} } }, "output": { "type": "structure", "members": { "CostCategoryArn": {}, "EffectiveEnd": {} } } }, "DescribeCostCategoryDefinition": { "input": { "type": "structure", "required": [ "CostCategoryArn" ], "members": { "CostCategoryArn": {}, "EffectiveOn": {} } }, "output": { "type": "structure", "members": { "CostCategory": { "type": "structure", "required": [ "CostCategoryArn", "EffectiveStart", "Name", "RuleVersion", "Rules" ], "members": { "CostCategoryArn": {}, "EffectiveStart": {}, "EffectiveEnd": {}, "Name": {}, "RuleVersion": {}, "Rules": { "shape": "S4" } } } } } }, "GetCostAndUsage": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "TimePeriod": { "shape": "Sr" }, "Granularity": {}, "Filter": { "shape": "S7" }, "Metrics": { "shape": "Su" }, "GroupBy": { "shape": "Sw" }, "NextPageToken": {} } }, "output": { "type": "structure", "members": { "NextPageToken": {}, "GroupDefinitions": { "shape": "Sw" }, "ResultsByTime": { "shape": "S12" } } } }, "GetCostAndUsageWithResources": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "TimePeriod": { "shape": "Sr" }, "Granularity": {}, "Filter": { "shape": "S7" }, "Metrics": { "shape": "Su" }, "GroupBy": { "shape": "Sw" }, "NextPageToken": {} } }, "output": { "type": "structure", "members": { "NextPageToken": {}, "GroupDefinitions": { "shape": "Sw" }, "ResultsByTime": { "shape": "S12" } } } }, "GetCostForecast": { "input": { "type": "structure", "required": [ "TimePeriod", "Metric", "Granularity" ], "members": { "TimePeriod": { "shape": "Sr" }, "Metric": {}, "Granularity": {}, "Filter": { "shape": "S7" }, "PredictionIntervalLevel": { "type": "integer" } } }, "output": { "type": "structure", "members": { "Total": { "shape": "S15" }, "ForecastResultsByTime": { "shape": "S1j" } } } }, "GetDimensionValues": { "input": { "type": "structure", "required": [ "TimePeriod", "Dimension" ], "members": { "SearchString": {}, "TimePeriod": { "shape": "Sr" }, "Dimension": {}, "Context": {}, "NextPageToken": {} } }, "output": { "type": "structure", "required": [ "DimensionValues", "ReturnSize", "TotalSize" ], "members": { "DimensionValues": { "type": "list", "member": { "type": "structure", "members": { "Value": {}, "Attributes": { "shape": "S1s" } } } }, "ReturnSize": { "type": "integer" }, "TotalSize": { "type": "integer" }, "NextPageToken": {} } } }, "GetReservationCoverage": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "TimePeriod": { "shape": "Sr" }, "GroupBy": { "shape": "Sw" }, "Granularity": {}, "Filter": { "shape": "S7" }, "Metrics": { "shape": "Su" }, "NextPageToken": {} } }, "output": { "type": "structure", "required": [ "CoveragesByTime" ], "members": { "CoveragesByTime": { "type": "list", "member": { "type": "structure", "members": { "TimePeriod": { "shape": "Sr" }, "Groups": { "type": "list", "member": { "type": "structure", "members": { "Attributes": { "shape": "S1s" }, "Coverage": { "shape": "S22" } } } }, "Total": { "shape": "S22" } } } }, "Total": { "shape": "S22" }, "NextPageToken": {} } } }, "GetReservationPurchaseRecommendation": { "input": { "type": "structure", "required": [ "Service" ], "members": { "AccountId": {}, "Service": {}, "AccountScope": {}, "LookbackPeriodInDays": {}, "TermInYears": {}, "PaymentOption": {}, "ServiceSpecification": { "shape": "S2k" }, "PageSize": { "type": "integer" }, "NextPageToken": {} } }, "output": { "type": "structure", "members": { "Metadata": { "type": "structure", "members": { "RecommendationId": {}, "GenerationTimestamp": {} } }, "Recommendations": { "type": "list", "member": { "type": "structure", "members": { "AccountScope": {}, "LookbackPeriodInDays": {}, "TermInYears": {}, "PaymentOption": {}, "ServiceSpecification": { "shape": "S2k" }, "RecommendationDetails": { "type": "list", "member": { "type": "structure", "members": { "AccountId": {}, "InstanceDetails": { "type": "structure", "members": { "EC2InstanceDetails": { "type": "structure", "members": { "Family": {}, "InstanceType": {}, "Region": {}, "AvailabilityZone": {}, "Platform": {}, "Tenancy": {}, "CurrentGeneration": { "type": "boolean" }, "SizeFlexEligible": { "type": "boolean" } } }, "RDSInstanceDetails": { "type": "structure", "members": { "Family": {}, "InstanceType": {}, "Region": {}, "DatabaseEngine": {}, "DatabaseEdition": {}, "DeploymentOption": {}, "LicenseModel": {}, "CurrentGeneration": { "type": "boolean" }, "SizeFlexEligible": { "type": "boolean" } } }, "RedshiftInstanceDetails": { "type": "structure", "members": { "Family": {}, "NodeType": {}, "Region": {}, "CurrentGeneration": { "type": "boolean" }, "SizeFlexEligible": { "type": "boolean" } } }, "ElastiCacheInstanceDetails": { "type": "structure", "members": { "Family": {}, "NodeType": {}, "Region": {}, "ProductDescription": {}, "CurrentGeneration": { "type": "boolean" }, "SizeFlexEligible": { "type": "boolean" } } }, "ESInstanceDetails": { "type": "structure", "members": { "InstanceClass": {}, "InstanceSize": {}, "Region": {}, "CurrentGeneration": { "type": "boolean" }, "SizeFlexEligible": { "type": "boolean" } } } } }, "RecommendedNumberOfInstancesToPurchase": {}, "RecommendedNormalizedUnitsToPurchase": {}, "MinimumNumberOfInstancesUsedPerHour": {}, "MinimumNormalizedUnitsUsedPerHour": {}, "MaximumNumberOfInstancesUsedPerHour": {}, "MaximumNormalizedUnitsUsedPerHour": {}, "AverageNumberOfInstancesUsedPerHour": {}, "AverageNormalizedUnitsUsedPerHour": {}, "AverageUtilization": {}, "EstimatedBreakEvenInMonths": {}, "CurrencyCode": {}, "EstimatedMonthlySavingsAmount": {}, "EstimatedMonthlySavingsPercentage": {}, "EstimatedMonthlyOnDemandCost": {}, "EstimatedReservationCostForLookbackPeriod": {}, "UpfrontCost": {}, "RecurringStandardMonthlyCost": {} } } }, "RecommendationSummary": { "type": "structure", "members": { "TotalEstimatedMonthlySavingsAmount": {}, "TotalEstimatedMonthlySavingsPercentage": {}, "CurrencyCode": {} } } } } }, "NextPageToken": {} } } }, "GetReservationUtilization": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "TimePeriod": { "shape": "Sr" }, "GroupBy": { "shape": "Sw" }, "Granularity": {}, "Filter": { "shape": "S7" }, "NextPageToken": {} } }, "output": { "type": "structure", "required": [ "UtilizationsByTime" ], "members": { "UtilizationsByTime": { "type": "list", "member": { "type": "structure", "members": { "TimePeriod": { "shape": "Sr" }, "Groups": { "type": "list", "member": { "type": "structure", "members": { "Key": {}, "Value": {}, "Attributes": { "shape": "S1s" }, "Utilization": { "shape": "S3a" } } } }, "Total": { "shape": "S3a" } } } }, "Total": { "shape": "S3a" }, "NextPageToken": {} } } }, "GetRightsizingRecommendation": { "input": { "type": "structure", "required": [ "Service" ], "members": { "Filter": { "shape": "S7" }, "Configuration": { "shape": "S3q" }, "Service": {}, "PageSize": { "type": "integer" }, "NextPageToken": {} } }, "output": { "type": "structure", "members": { "Metadata": { "type": "structure", "members": { "RecommendationId": {}, "GenerationTimestamp": {}, "LookbackPeriodInDays": {} } }, "Summary": { "type": "structure", "members": { "TotalRecommendationCount": {}, "EstimatedTotalMonthlySavingsAmount": {}, "SavingsCurrencyCode": {}, "SavingsPercentage": {} } }, "RightsizingRecommendations": { "type": "list", "member": { "type": "structure", "members": { "AccountId": {}, "CurrentInstance": { "type": "structure", "members": { "ResourceId": {}, "InstanceName": {}, "Tags": { "type": "list", "member": { "shape": "Sf" } }, "ResourceDetails": { "shape": "S3z" }, "ResourceUtilization": { "shape": "S41" }, "ReservationCoveredHoursInLookbackPeriod": {}, "SavingsPlansCoveredHoursInLookbackPeriod": {}, "OnDemandHoursInLookbackPeriod": {}, "TotalRunningHoursInLookbackPeriod": {}, "MonthlyCost": {}, "CurrencyCode": {} } }, "RightsizingType": {}, "ModifyRecommendationDetail": { "type": "structure", "members": { "TargetInstances": { "type": "list", "member": { "type": "structure", "members": { "EstimatedMonthlyCost": {}, "EstimatedMonthlySavings": {}, "CurrencyCode": {}, "DefaultTargetInstance": { "type": "boolean" }, "ResourceDetails": { "shape": "S3z" }, "ExpectedResourceUtilization": { "shape": "S41" } } } } } }, "TerminateRecommendationDetail": { "type": "structure", "members": { "EstimatedMonthlySavings": {}, "CurrencyCode": {} } } } } }, "NextPageToken": {}, "Configuration": { "shape": "S3q" } } } }, "GetSavingsPlansCoverage": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "TimePeriod": { "shape": "Sr" }, "GroupBy": { "shape": "Sw" }, "Granularity": {}, "Filter": { "shape": "S7" }, "Metrics": { "shape": "Su" }, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "required": [ "SavingsPlansCoverages" ], "members": { "SavingsPlansCoverages": { "type": "list", "member": { "type": "structure", "members": { "Attributes": { "shape": "S1s" }, "Coverage": { "type": "structure", "members": { "SpendCoveredBySavingsPlans": {}, "OnDemandCost": {}, "TotalCost": {}, "CoveragePercentage": {} } }, "TimePeriod": { "shape": "Sr" } } } }, "NextToken": {} } } }, "GetSavingsPlansPurchaseRecommendation": { "input": { "type": "structure", "required": [ "SavingsPlansType", "TermInYears", "PaymentOption", "LookbackPeriodInDays" ], "members": { "SavingsPlansType": {}, "TermInYears": {}, "PaymentOption": {}, "AccountScope": {}, "NextPageToken": {}, "PageSize": { "type": "integer" }, "LookbackPeriodInDays": {}, "Filter": { "shape": "S7" } } }, "output": { "type": "structure", "members": { "Metadata": { "type": "structure", "members": { "RecommendationId": {}, "GenerationTimestamp": {} } }, "SavingsPlansPurchaseRecommendation": { "type": "structure", "members": { "AccountScope": {}, "SavingsPlansType": {}, "TermInYears": {}, "PaymentOption": {}, "LookbackPeriodInDays": {}, "SavingsPlansPurchaseRecommendationDetails": { "type": "list", "member": { "type": "structure", "members": { "SavingsPlansDetails": { "type": "structure", "members": { "Region": {}, "InstanceFamily": {}, "OfferingId": {} } }, "AccountId": {}, "UpfrontCost": {}, "EstimatedROI": {}, "CurrencyCode": {}, "EstimatedSPCost": {}, "EstimatedOnDemandCost": {}, "EstimatedOnDemandCostWithCurrentCommitment": {}, "EstimatedSavingsAmount": {}, "EstimatedSavingsPercentage": {}, "HourlyCommitmentToPurchase": {}, "EstimatedAverageUtilization": {}, "EstimatedMonthlySavingsAmount": {}, "CurrentMinimumHourlyOnDemandSpend": {}, "CurrentMaximumHourlyOnDemandSpend": {}, "CurrentAverageHourlyOnDemandSpend": {} } } }, "SavingsPlansPurchaseRecommendationSummary": { "type": "structure", "members": { "EstimatedROI": {}, "CurrencyCode": {}, "EstimatedTotalCost": {}, "CurrentOnDemandSpend": {}, "EstimatedSavingsAmount": {}, "TotalRecommendationCount": {}, "DailyCommitmentToPurchase": {}, "HourlyCommitmentToPurchase": {}, "EstimatedSavingsPercentage": {}, "EstimatedMonthlySavingsAmount": {}, "EstimatedOnDemandCostWithCurrentCommitment": {} } } } }, "NextPageToken": {} } } }, "GetSavingsPlansUtilization": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "TimePeriod": { "shape": "Sr" }, "Granularity": {}, "Filter": { "shape": "S7" } } }, "output": { "type": "structure", "required": [ "Total" ], "members": { "SavingsPlansUtilizationsByTime": { "type": "list", "member": { "type": "structure", "required": [ "TimePeriod", "Utilization" ], "members": { "TimePeriod": { "shape": "Sr" }, "Utilization": { "shape": "S4r" }, "Savings": { "shape": "S4s" }, "AmortizedCommitment": { "shape": "S4t" } } } }, "Total": { "shape": "S4u" } } } }, "GetSavingsPlansUtilizationDetails": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "TimePeriod": { "shape": "Sr" }, "Filter": { "shape": "S7" }, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "required": [ "SavingsPlansUtilizationDetails", "TimePeriod" ], "members": { "SavingsPlansUtilizationDetails": { "type": "list", "member": { "type": "structure", "members": { "SavingsPlanArn": {}, "Attributes": { "shape": "S1s" }, "Utilization": { "shape": "S4r" }, "Savings": { "shape": "S4s" }, "AmortizedCommitment": { "shape": "S4t" } } } }, "Total": { "shape": "S4u" }, "TimePeriod": { "shape": "Sr" }, "NextToken": {} } } }, "GetTags": { "input": { "type": "structure", "required": [ "TimePeriod" ], "members": { "SearchString": {}, "TimePeriod": { "shape": "Sr" }, "TagKey": {}, "NextPageToken": {} } }, "output": { "type": "structure", "required": [ "Tags", "ReturnSize", "TotalSize" ], "members": { "NextPageToken": {}, "Tags": { "type": "list", "member": {} }, "ReturnSize": { "type": "integer" }, "TotalSize": { "type": "integer" } } } }, "GetUsageForecast": { "input": { "type": "structure", "required": [ "TimePeriod", "Metric", "Granularity" ], "members": { "TimePeriod": { "shape": "Sr" }, "Metric": {}, "Granularity": {}, "Filter": { "shape": "S7" }, "PredictionIntervalLevel": { "type": "integer" } } }, "output": { "type": "structure", "members": { "Total": { "shape": "S15" }, "ForecastResultsByTime": { "shape": "S1j" } } } }, "ListCostCategoryDefinitions": { "input": { "type": "structure", "members": { "EffectiveOn": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "CostCategoryReferences": { "type": "list", "member": { "type": "structure", "members": { "CostCategoryArn": {}, "Name": {}, "EffectiveStart": {}, "EffectiveEnd": {}, "NumberOfRules": { "type": "integer" } } } }, "NextToken": {} } } }, "UpdateCostCategoryDefinition": { "input": { "type": "structure", "required": [ "CostCategoryArn", "RuleVersion", "Rules" ], "members": { "CostCategoryArn": {}, "RuleVersion": {}, "Rules": { "shape": "S4" } } }, "output": { "type": "structure", "members": { "CostCategoryArn": {}, "EffectiveStart": {} } } } }, "shapes": { "S4": { "type": "list", "member": { "type": "structure", "required": [ "Value", "Rule" ], "members": { "Value": {}, "Rule": { "shape": "S7" } } } }, "S7": { "type": "structure", "members": { "Or": { "shape": "S8" }, "And": { "shape": "S8" }, "Not": { "shape": "S7" }, "Dimensions": { "type": "structure", "members": { "Key": {}, "Values": { "shape": "Sb" }, "MatchOptions": { "shape": "Sd" } } }, "Tags": { "shape": "Sf" }, "CostCategories": { "type": "structure", "members": { "Key": {}, "Values": { "shape": "Sb" } } } } }, "S8": { "type": "list", "member": { "shape": "S7" } }, "Sb": { "type": "list", "member": {} }, "Sd": { "type": "list", "member": {} }, "Sf": { "type": "structure", "members": { "Key": {}, "Values": { "shape": "Sb" }, "MatchOptions": { "shape": "Sd" } } }, "Sr": { "type": "structure", "required": [ "Start", "End" ], "members": { "Start": {}, "End": {} } }, "Su": { "type": "list", "member": {} }, "Sw": { "type": "list", "member": { "type": "structure", "members": { "Type": {}, "Key": {} } } }, "S12": { "type": "list", "member": { "type": "structure", "members": { "TimePeriod": { "shape": "Sr" }, "Total": { "shape": "S14" }, "Groups": { "type": "list", "member": { "type": "structure", "members": { "Keys": { "type": "list", "member": {} }, "Metrics": { "shape": "S14" } } } }, "Estimated": { "type": "boolean" } } } }, "S14": { "type": "map", "key": {}, "value": { "shape": "S15" } }, "S15": { "type": "structure", "members": { "Amount": {}, "Unit": {} } }, "S1j": { "type": "list", "member": { "type": "structure", "members": { "TimePeriod": { "shape": "Sr" }, "MeanValue": {}, "PredictionIntervalLowerBound": {}, "PredictionIntervalUpperBound": {} } } }, "S1s": { "type": "map", "key": {}, "value": {} }, "S22": { "type": "structure", "members": { "CoverageHours": { "type": "structure", "members": { "OnDemandHours": {}, "ReservedHours": {}, "TotalRunningHours": {}, "CoverageHoursPercentage": {} } }, "CoverageNormalizedUnits": { "type": "structure", "members": { "OnDemandNormalizedUnits": {}, "ReservedNormalizedUnits": {}, "TotalRunningNormalizedUnits": {}, "CoverageNormalizedUnitsPercentage": {} } }, "CoverageCost": { "type": "structure", "members": { "OnDemandCost": {} } } } }, "S2k": { "type": "structure", "members": { "EC2Specification": { "type": "structure", "members": { "OfferingClass": {} } } } }, "S3a": { "type": "structure", "members": { "UtilizationPercentage": {}, "UtilizationPercentageInUnits": {}, "PurchasedHours": {}, "PurchasedUnits": {}, "TotalActualHours": {}, "TotalActualUnits": {}, "UnusedHours": {}, "UnusedUnits": {}, "OnDemandCostOfRIHoursUsed": {}, "NetRISavings": {}, "TotalPotentialRISavings": {}, "AmortizedUpfrontFee": {}, "AmortizedRecurringFee": {}, "TotalAmortizedFee": {} } }, "S3q": { "type": "structure", "required": [ "RecommendationTarget", "BenefitsConsidered" ], "members": { "RecommendationTarget": {}, "BenefitsConsidered": { "type": "boolean" } } }, "S3z": { "type": "structure", "members": { "EC2ResourceDetails": { "type": "structure", "members": { "HourlyOnDemandRate": {}, "InstanceType": {}, "Platform": {}, "Region": {}, "Sku": {}, "Memory": {}, "NetworkPerformance": {}, "Storage": {}, "Vcpu": {} } } } }, "S41": { "type": "structure", "members": { "EC2ResourceUtilization": { "type": "structure", "members": { "MaxCpuUtilizationPercentage": {}, "MaxMemoryUtilizationPercentage": {}, "MaxStorageUtilizationPercentage": {} } } } }, "S4r": { "type": "structure", "members": { "TotalCommitment": {}, "UsedCommitment": {}, "UnusedCommitment": {}, "UtilizationPercentage": {} } }, "S4s": { "type": "structure", "members": { "NetSavings": {}, "OnDemandCostEquivalent": {} } }, "S4t": { "type": "structure", "members": { "AmortizedRecurringCommitment": {}, "AmortizedUpfrontCommitment": {}, "TotalAmortizedCommitment": {} } }, "S4u": { "type": "structure", "required": [ "Utilization" ], "members": { "Utilization": { "shape": "S4r" }, "Savings": { "shape": "S4s" }, "AmortizedCommitment": { "shape": "S4t" } } } } }