Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
Amazon Web Services 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 Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.
For example, Amazon Web Services 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. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of normalized units. This way, you can purchase any instance size that you want. For this example, your RI recommendation is for c4.large because that is the smallest size instance in the c4 instance family.
Retrieves the reservation utilization for your account. Management account 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.
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.
", + "GetSavingsPlanPurchaseRecommendationDetails": "Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the new cost, coverage, and utilization charts.
", "GetSavingsPlansCoverage": "Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
To determine valid values for a dimension, use the GetDimensionValues operation.
Retrieves the Savings Plans recommendations for your account. First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.
You can't group by any dimension values for GetSavingsPlansUtilization.
An API operation for adding one or more tags (key-value pairs) to a resource.
You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag.
Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
", "UntagResource": "Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
", "UpdateAnomalyMonitor": "Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
", - "UpdateAnomalySubscription": "Updates an existing cost anomaly monitor subscription.
", + "UpdateAnomalySubscription": "Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.
The JSON below describes the generic construct for each type. See Request Parameters for possible values as they apply to AnomalySubscription.
Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).
", "UpdateCostCategoryDefinition": "Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
" }, @@ -46,6 +47,7 @@ "refs": { "GetReservationPurchaseRecommendationRequest$AccountScope": "The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
", "ReservationPurchaseRecommendation$AccountScope": "The account scope that Amazon Web Services recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in Amazon Web Services Organizations.
", "SavingsPlansPurchaseRecommendation$AccountScope": "The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that include the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
The association between a monitor, threshold, and list of subscribers used to deliver notifications about anomalies detected by a monitor that exceeds a threshold. The content consists of the detailed metadata and the current status of the AnomalySubscription object.
An AnomalySubscription resource (also referred to as an alert subscription) sends notifications about specific anomalies that meet an alerting criteria defined by you.
You can specify the frequency of the alerts and the subscribers to notify.
Anomaly subscriptions can be associated with one or more AnomalyMonitor resources, and they only send notifications about anomalies detected by those associated monitors. You can also configure a threshold to further control which anomalies are included in the notifications.
Anomalies that don’t exceed the chosen threshold and therefore don’t trigger notifications from an anomaly subscription will still be available on the console and from the GetAnomalies API.
The cost anomaly subscription object that you want to create.
" @@ -117,7 +119,7 @@ "AnomalySubscriptionFrequency": { "base": null, "refs": { - "AnomalySubscription$Frequency": "The frequency that anomaly reports are sent over email.
", + "AnomalySubscription$Frequency": "The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.
", "UpdateAnomalySubscriptionRequest$Frequency": "The update to the frequency value that subscribers receive notifications.
" } }, @@ -671,11 +673,11 @@ } }, "Expression": { - "base": "Use Expression to filter in various Cost Explorer APIs.
Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.
There are two patterns:
Simple dimension values.
There are three types of simple dimension values: CostCategories, Tags, and Dimensions.
Specify the CostCategories field to define a filter that acts on Cost Categories.
Specify the Tags field to define a filter that acts on Cost Allocation Tags.
Specify the Dimensions field to define a filter that acts on the DimensionValues .
For each filter type, you can set the dimension name and values for the filters that you plan to use.
For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).
The corresponding Expression for this example is as follows: { \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", “us-west-1” ] } }
As shown in the previous example, lists of dimension values are combined with OR when applying the filter.
You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
For example, you can filter for linked account names that start with “a”.
The corresponding Expression for this example is as follows: { \"Dimensions\": { \"Key\": \"LINKED_ACCOUNT_NAME\", \"MatchOptions\": [ \"STARTS_WITH\" ], \"Values\": [ \"a\" ] } }
Compound Expression types with logical operations.
You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.
For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).
The corresponding Expression for this example is as follows: { \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] }
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { \"And\": [ ... ], \"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } }
The following is an example of the corresponding error message: \"Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories\"
For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.
Use Expression to filter in various Cost Explorer APIs.
Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.
There are two patterns:
Simple dimension values.
There are three types of simple dimension values: CostCategories, Tags, and Dimensions.
Specify the CostCategories field to define a filter that acts on Cost Categories.
Specify the Tags field to define a filter that acts on Cost Allocation Tags.
Specify the Dimensions field to define a filter that acts on the DimensionValues .
For each filter type, you can set the dimension name and values for the filters that you plan to use.
For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).
The corresponding Expression for this example is as follows: { \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", \"us-west-1\" ] } }
As shown in the previous example, lists of dimension values are combined with OR when applying the filter.
You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
For example, you can filter for linked account names that start with \"a\".
The corresponding Expression for this example is as follows: { \"Dimensions\": { \"Key\": \"LINKED_ACCOUNT_NAME\", \"MatchOptions\": [ \"STARTS_WITH\" ], \"Values\": [ \"a\" ] } }
Compound Expression types with logical operations.
You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.
For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).
The corresponding Expression for this example is as follows: { \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] }
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { \"And\": [ ... ], \"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } }
The following is an example of the corresponding error message: \"Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories\"
For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.
An Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE. The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000.
One of Threshold or ThresholdExpression is required for this resource.
The following are examples of valid ThresholdExpressions:
Absolute threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
Percentage threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
AND two thresholds together: { \"And\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
OR two thresholds together: { \"Or\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME.
Root level OR isn't supported. We recommend that you create a separate rule instead.
RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.
An Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.
One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
The following are examples of valid ThresholdExpressions:
Absolute threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
Percentage threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
AND two thresholds together: { \"And\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
OR two thresholds together: { \"Or\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, LINKED_ACCOUNT_NAME, REGION, and USAGE_TYPE.
RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.
Return results that don't match a Dimension object.
Filters Amazon Web Services 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.
Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
LINKED_ACCOUNT
SAVINGS_PLAN_ARN
SAVINGS_PLANS_TYPE
REGION
PAYMENT_OPTION
INSTANCE_TYPE_FAMILY
GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:
AZ
INSTANCE_TYPE
LINKED_ACCOUNT
LINKED_ACCOUNT_NAME
OPERATION
PURCHASE_TYPE
REGION
SERVICE
USAGE_TYPE
USAGE_TYPE_GROUP
RECORD_TYPE
OPERATING_SYSTEM
TENANCY
SCOPE
PLATFORM
SUBSCRIPTION_ID
LEGAL_ENTITY_NAME
DEPLOYMENT_OPTION
DATABASE_ENGINE
INSTANCE_TYPE_FAMILY
BILLING_ENTITY
RESERVATION_ID
SAVINGS_PLAN_ARN
The update to the Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE. The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000.
The following are examples of valid ThresholdExpressions:
Absolute threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
Percentage threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
AND two thresholds together: { \"And\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
OR two thresholds together: { \"Or\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
The update to the Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.
You can specify either Threshold or ThresholdExpression, but not both.
The following are examples of valid ThresholdExpressions:
Absolute threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
Percentage threshold: { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }
AND two thresholds together: { \"And\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
OR two thresholds together: { \"Or\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }
The database edition that the recommended reservation supports.
", "RDSInstanceDetails$DeploymentOption": "Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.
", "RDSInstanceDetails$LicenseModel": "The license model that the recommended reservation supports.
", + "RecommendationDetailData$AccountId": "The AccountID that the recommendation is generated for.
", + "RecommendationDetailData$CurrencyCode": "The currency code that Amazon Web Services used to generate the recommendation and present potential savings.
", + "RecommendationDetailData$InstanceFamily": "The instance family of the recommended Savings Plan.
", + "RecommendationDetailData$Region": "The region the recommendation is generated for.
", + "RecommendationDetailData$OfferingId": "The unique ID that's used to distinguish Savings Plans from one another.
", + "RecommendationDetailData$CurrentAverageHourlyOnDemandSpend": "The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
", + "RecommendationDetailData$CurrentMaximumHourlyOnDemandSpend": "The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.
", + "RecommendationDetailData$CurrentMinimumHourlyOnDemandSpend": "The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.
", + "RecommendationDetailData$EstimatedAverageUtilization": "The estimated utilization of the recommended Savings Plan.
", + "RecommendationDetailData$EstimatedMonthlySavingsAmount": "The estimated monthly savings amount based on the recommended Savings Plan.
", + "RecommendationDetailData$EstimatedOnDemandCost": "The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.
", + "RecommendationDetailData$EstimatedOnDemandCostWithCurrentCommitment": "The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plan you own.
", + "RecommendationDetailData$EstimatedROI": "The estimated return on investment that's based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.
", + "RecommendationDetailData$EstimatedSPCost": "The cost of the recommended Savings Plan over the length of the lookback period.
", + "RecommendationDetailData$EstimatedSavingsAmount": "The estimated savings amount that's based on the recommended Savings Plan over the length of the lookback period.
", + "RecommendationDetailData$EstimatedSavingsPercentage": "The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.
", + "RecommendationDetailData$ExistingHourlyCommitment": "The existing hourly commitment for the Savings Plan type.
", + "RecommendationDetailData$HourlyCommitmentToPurchase": "The recommended hourly commitment level for the Savings Plan type and the configuration that's based on the usage during the lookback period.
", + "RecommendationDetailData$UpfrontCost": "The upfront cost of the recommended Savings Plan, based on the selected payment option.
", + "RecommendationDetailData$CurrentAverageCoverage": "The average value of hourly coverage over the lookback period.
", + "RecommendationDetailData$EstimatedAverageCoverage": "The estimated coverage of the recommended Savings Plan.
", + "RecommendationDetailHourlyMetrics$EstimatedOnDemandCost": "The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.
", + "RecommendationDetailHourlyMetrics$CurrentCoverage": "The current amount of Savings Plans eligible usage that the Savings Plan covered.
", + "RecommendationDetailHourlyMetrics$EstimatedCoverage": "The estimated coverage amount based on the recommended Savings Plan.
", + "RecommendationDetailHourlyMetrics$EstimatedNewCommitmentUtilization": "The estimated utilization for the recommended Savings Plan.
", "RedshiftInstanceDetails$Family": "The instance family of the recommended reservation.
", "RedshiftInstanceDetails$NodeType": "The type of node that Amazon Web Services recommends.
", "RedshiftInstanceDetails$Region": "The Amazon Web Services Region of the recommended reservation.
", @@ -1079,6 +1106,16 @@ "refs": { } }, + "GetSavingsPlanPurchaseRecommendationDetailsRequest": { + "base": null, + "refs": { + } + }, + "GetSavingsPlanPurchaseRecommendationDetailsResponse": { + "base": null, + "refs": { + } + }, "GetSavingsPlansCoverageRequest": { "base": null, "refs": { @@ -1273,6 +1310,7 @@ "refs": { "GetReservationPurchaseRecommendationRequest$LookbackPeriodInDays": "The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.
", "GetSavingsPlansPurchaseRecommendationRequest$LookbackPeriodInDays": "The lookback period that's used to generate the recommendation.
", + "RecommendationDetailData$LookbackPeriodInDays": "How many days of previous usage that Amazon Web Services considers when making this recommendation.
", "ReservationPurchaseRecommendation$LookbackPeriodInDays": "How many days of previous usage that Amazon Web Services considers when making this recommendation.
", "RightsizingRecommendationMetadata$LookbackPeriodInDays": "The number of days of previous usage that Amazon Web Services considers when making this recommendation.
", "SavingsPlansPurchaseRecommendation$LookbackPeriodInDays": "The lookback period in days that's used to generate the recommendation.
" @@ -1354,6 +1392,12 @@ "ResultByTime$Total": "The total amount of cost or usage accrued during the time period.
" } }, + "MetricsOverLookbackPeriod": { + "base": null, + "refs": { + "RecommendationDetailData$MetricsOverLookbackPeriod": "The related hourly cost, coverage, and utilization metrics over the lookback period.
" + } + }, "ModifyRecommendationDetail": { "base": "Details for the modification recommendation.
", "refs": { @@ -1446,11 +1490,11 @@ "NullableNonNegativeDouble": { "base": null, "refs": { - "AnomalySubscription$Threshold": "(deprecated)
The dollar value that triggers a notification if the threshold is exceeded.
This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
One of Threshold or ThresholdExpression is required for this resource.
", + "AnomalySubscription$Threshold": "(deprecated)
An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.
This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
", "Impact$TotalActualSpend": "The cumulative dollar amount that was actually spent during the anomaly.
", "Impact$TotalExpectedSpend": "The cumulative dollar amount that was expected to be spent during the anomaly. It is calculated using advanced machine learning models to determine the typical spending pattern based on historical data for a customer.
", "Impact$TotalImpactPercentage": "The cumulative percentage difference between the total actual spend and total expected spend. It is calculated as (TotalImpact / TotalExpectedSpend) * 100. When TotalExpectedSpend is zero, this field is omitted. Expected spend can be zero in situations such as when you start to use a service for the first time.
(deprecated)
The update to the threshold value for receiving notifications.
This field has been deprecated. To update a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
" + "UpdateAnomalySubscriptionRequest$Threshold": "(deprecated)
The update to the threshold value for receiving notifications.
This field has been deprecated. To update a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
You can specify either Threshold or ThresholdExpression, but not both.
" } }, "NumericOperator": { @@ -1508,6 +1552,7 @@ "refs": { "GetReservationPurchaseRecommendationRequest$PaymentOption": "The reservation purchase option that you want recommendations for.
", "GetSavingsPlansPurchaseRecommendationRequest$PaymentOption": "The payment option that's used to generate these recommendations.
", + "RecommendationDetailData$PaymentOption": "The payment option for the commitment (for example, All Upfront or No Upfront).
", "ReservationPurchaseRecommendation$PaymentOption": "The payment option for the reservation (for example, AllUpfront or NoUpfront).
The payment option that's used to generate the recommendation.
" } @@ -1571,6 +1616,26 @@ "ReservationAggregates$RealizedSavings": "The realized savings because of purchasing and using a reservation.
" } }, + "RecommendationDetailData": { + "base": "The details and metrics for the given recommendation.
", + "refs": { + "GetSavingsPlanPurchaseRecommendationDetailsResponse$RecommendationDetailData": "Contains detailed information about a specific Savings Plan recommendation.
" + } + }, + "RecommendationDetailHourlyMetrics": { + "base": "Contains the hourly metrics for the given recommendation over the lookback period.
", + "refs": { + "MetricsOverLookbackPeriod$member": null + } + }, + "RecommendationDetailId": { + "base": null, + "refs": { + "GetSavingsPlanPurchaseRecommendationDetailsRequest$RecommendationDetailId": "The ID that is associated with the Savings Plan recommendation.
", + "GetSavingsPlanPurchaseRecommendationDetailsResponse$RecommendationDetailId": "The ID that is associated with the Savings Plan recommendation.
", + "SavingsPlansPurchaseRecommendationDetail$RecommendationDetailId": "Contains detailed information about a specific Savings Plan recommendation.
" + } + }, "RecommendationId": { "base": null, "refs": { @@ -2033,6 +2098,7 @@ "base": null, "refs": { "GetSavingsPlansPurchaseRecommendationRequest$SavingsPlansType": "The Savings Plans recommendation type that's requested.
", + "RecommendationDetailData$SavingsPlansType": "The requested Savings Plan recommendation type.
", "SavingsPlansPurchaseRecommendation$SavingsPlansType": "The requested Savings Plans recommendation type.
" } }, @@ -2093,6 +2159,7 @@ "refs": { "GetReservationPurchaseRecommendationRequest$TermInYears": "The reservation term that you want recommendations for.
", "GetSavingsPlansPurchaseRecommendationRequest$TermInYears": "The savings plan recommendation term that's used to generate these recommendations.
", + "RecommendationDetailData$TermInYears": "The term of the commitment in years.
", "ReservationPurchaseRecommendation$TermInYears": "The term of the reservation that you want recommendations for, in years.
", "SavingsPlansPurchaseRecommendation$TermInYears": "The Savings Plans recommendation term in years. It's used to generate the recommendation.
" } @@ -2315,6 +2382,9 @@ "GenerationSummary$GenerationCompletionTime": "Indicates the completion time of the recommendation generation.
", "GenerationSummary$EstimatedCompletionTime": "Indicates the estimated time for when the recommendation generation will complete.
", "ListCostCategoryDefinitionsRequest$EffectiveOn": "The date when the Cost Category was effective.
", + "RecommendationDetailData$GenerationTimestamp": null, + "RecommendationDetailData$LatestUsageTimestamp": null, + "RecommendationDetailHourlyMetrics$StartTime": null, "StartSavingsPlansPurchaseRecommendationGenerationResponse$GenerationStartedTime": "The start time of the recommendation generation.
", "StartSavingsPlansPurchaseRecommendationGenerationResponse$EstimatedCompletionTime": "The estimated time for when the recommendation generation will complete.
", "UpdateCostCategoryDefinitionRequest$EffectiveStart": "The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.
", diff --git a/models/apis/ce/2017-10-25/endpoint-rule-set-1.json b/models/apis/ce/2017-10-25/endpoint-rule-set-1.json index 09cea2bc7d5..e4c99e99633 100644 --- a/models/apis/ce/2017-10-25/endpoint-rule-set-1.json +++ b/models/apis/ce/2017-10-25/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,64 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "isSet", "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" + "ref": "Region" + } ] } ], @@ -128,22 +111,13 @@ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ { - "ref": "UseDualStack" - }, - true - ] + "ref": "Region" + } + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -151,556 +125,303 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] - } + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false ] }, { "fn": "booleanEquals", "argv": [ - true, + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://ce.us-east-1.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "ce", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] + }, + "aws-cn" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://ce.cn-northwest-1.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "ce", + "signingRegion": "cn-northwest-1" } ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://cost-explorer-fips.{Region}.api.aws", - "properties": { - "authSchemes": [ + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "ce" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] } ] }, - "headers": {} - }, - "type": "endpoint" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ce-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } + "ref": "UseFIPS" + }, + true ] } ], "type": "tree", "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://cost-explorer-fips.{Region}.amazonaws.com", - "properties": { - "authSchemes": [ + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "ce" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] } ] - }, - "headers": {} - }, - "type": "endpoint" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ce-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "ref": "UseDualStack" + }, + true ] } ], "type": "tree", "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://cost-explorer.{Region}.api.aws", - "properties": { - "authSchemes": [ + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "ce" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] } ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://ce.us-east-1.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "ce" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + ], + "type": "tree", + "rules": [ { - "fn": "getAttr", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://cost-explorer-fips.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "ce" + "conditions": [], + "endpoint": { + "url": "https://ce.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://cost-explorer-fips.{Region}.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "ce" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ { "conditions": [], - "endpoint": { - "url": "https://cost-explorer.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "ce" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://ce.cn-northwest-1.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "ce" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ce-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ { "conditions": [], "type": "tree", @@ -708,7 +429,7 @@ { "conditions": [], "endpoint": { - "url": "https://ce-fips.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://ce.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -717,134 +438,13 @@ ] } ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ce.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-global" - ] - } - ], - "endpoint": { - "url": "https://ce.us-east-1.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "ce" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-cn-global" - ] - } - ], - "endpoint": { - "url": "https://ce.cn-northwest-1.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "ce" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://ce.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/ce/2017-10-25/endpoint-tests-1.json b/models/apis/ce/2017-10-25/endpoint-tests-1.json index b733909b76d..26d783f3157 100644 --- a/models/apis/ce/2017-10-25/endpoint-tests-1.json +++ b/models/apis/ce/2017-10-25/endpoint-tests-1.json @@ -1,5 +1,88 @@ { "testCases": [ + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "ce", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://ce.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ce.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "ce", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://ce.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", "expect": { @@ -7,9 +90,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "cn-northwest-1", "name": "sigv4", - "signingName": "ce" + "signingName": "ce", + "signingRegion": "cn-northwest-1" } ] }, @@ -17,35 +100,236 @@ } }, "params": { + "Region": "aws-cn-global", "UseFIPS": false, - "UseDualStack": false, - "Region": "aws-cn-global" + "UseDualStack": false } }, { - "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ce.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", - "signingName": "ce" + "signingName": "ce", + "signingRegion": "cn-northwest-1" } ] }, - "url": "https://ce.us-east-1.amazonaws.com" + "url": "https://ce.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ce.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce.us-gov-east-1.amazonaws.com" } }, "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ce.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, - "Region": "aws-global" + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -54,7 +338,6 @@ "params": { "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -64,9 +347,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -76,11 +359,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json index 1ebbf87c426..212236c7e05 100644 --- a/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json @@ -375,6 +375,21 @@ } }, "shapes":{ + "ActiveSpeakerOnlyConfiguration":{ + "type":"structure", + "members":{ + "ActiveSpeakerPosition":{"shape":"ActiveSpeakerPosition"} + } + }, + "ActiveSpeakerPosition":{ + "type":"string", + "enum":[ + "TopLeft", + "TopRight", + "BottomLeft", + "BottomRight" + ] + }, "AmazonResourceName":{ "type":"string", "max":1011, @@ -402,7 +417,6 @@ }, "AmazonTranscribeProcessorConfiguration":{ "type":"structure", - "required":["LanguageCode"], "members":{ "LanguageCode":{"shape":"CallAnalyticsLanguageCode"}, "VocabularyName":{"shape":"VocabularyName"}, @@ -415,7 +429,12 @@ "ContentRedactionType":{"shape":"ContentType"}, "PiiEntityTypes":{"shape":"PiiEntityTypes"}, "LanguageModelName":{"shape":"ModelName"}, - "FilterPartialResults":{"shape":"Boolean"} + "FilterPartialResults":{"shape":"Boolean"}, + "IdentifyLanguage":{"shape":"Boolean"}, + "LanguageOptions":{"shape":"LanguageOptions"}, + "PreferredLanguage":{"shape":"CallAnalyticsLanguageCode"}, + "VocabularyNames":{"shape":"VocabularyNames"}, + "VocabularyFilterNames":{"shape":"VocabularyFilterNames"} } }, "Arn":{ @@ -527,6 +546,22 @@ "exception":true }, "Boolean":{"type":"boolean"}, + "BorderColor":{ + "type":"string", + "enum":[ + "Black", + "Blue", + "Red", + "Green", + "White", + "Yellow" + ] + }, + "BorderThickness":{ + "type":"integer", + "max":20, + "min":1 + }, "CallAnalyticsLanguageCode":{ "type":"string", "enum":[ @@ -541,6 +576,13 @@ "pt-BR" ] }, + "CanvasOrientation":{ + "type":"string", + "enum":[ + "Landscape", + "Portrait" + ] + }, "CategoryName":{ "type":"string", "max":200, @@ -705,13 +747,19 @@ "enum":[ "PresenterOnly", "Horizontal", - "Vertical" + "Vertical", + "ActiveSpeakerOnly" ] }, "ContentType":{ "type":"string", "enum":["PII"] }, + "CornerRadius":{ + "type":"integer", + "max":20, + "min":1 + }, "CreateMediaCapturePipelineRequest":{ "type":"structure", "required":[ @@ -984,7 +1032,12 @@ "required":["ContentShareLayout"], "members":{ "ContentShareLayout":{"shape":"ContentShareLayoutOption"}, - "PresenterOnlyConfiguration":{"shape":"PresenterOnlyConfiguration"} + "PresenterOnlyConfiguration":{"shape":"PresenterOnlyConfiguration"}, + "ActiveSpeakerOnlyConfiguration":{"shape":"ActiveSpeakerOnlyConfiguration"}, + "HorizontalLayoutConfiguration":{"shape":"HorizontalLayoutConfiguration"}, + "VerticalLayoutConfiguration":{"shape":"VerticalLayoutConfiguration"}, + "VideoAttribute":{"shape":"VideoAttribute"}, + "CanvasOrientation":{"shape":"CanvasOrientation"} } }, "GuidString":{ @@ -993,6 +1046,33 @@ "min":36, "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" }, + "HighlightColor":{ + "type":"string", + "enum":[ + "Black", + "Blue", + "Red", + "Green", + "White", + "Yellow" + ] + }, + "HorizontalLayoutConfiguration":{ + "type":"structure", + "members":{ + "TileOrder":{"shape":"TileOrder"}, + "TilePosition":{"shape":"HorizontalTilePosition"}, + "TileCount":{"shape":"TileCount"}, + "TileAspectRatio":{"shape":"TileAspectRatio"} + } + }, + "HorizontalTilePosition":{ + "type":"string", + "enum":[ + "Top", + "Bottom" + ] + }, "Iso8601Timestamp":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -1070,6 +1150,12 @@ "InsightsTarget":{"shape":"Arn"} } }, + "LanguageOptions":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[a-zA-Z-,]+" + }, "LayoutOption":{ "type":"string", "enum":["GridView"] @@ -1764,6 +1850,22 @@ "error":{"httpStatusCode":429}, "exception":true }, + "TileAspectRatio":{ + "type":"string", + "pattern":"^\\d{1,2}\\/\\d{1,2}$" + }, + "TileCount":{ + "type":"integer", + "max":10, + "min":1 + }, + "TileOrder":{ + "type":"string", + "enum":[ + "JoinSequence", + "SpeakerSequence" + ] + }, "Timestamp":{"type":"timestamp"}, "TimestampRange":{ "type":"structure", @@ -1848,6 +1950,22 @@ "UpdateStatus":{"shape":"MediaPipelineStatusUpdate"} } }, + "VerticalLayoutConfiguration":{ + "type":"structure", + "members":{ + "TileOrder":{"shape":"TileOrder"}, + "TilePosition":{"shape":"VerticalTilePosition"}, + "TileCount":{"shape":"TileCount"}, + "TileAspectRatio":{"shape":"TileAspectRatio"} + } + }, + "VerticalTilePosition":{ + "type":"string", + "enum":[ + "Left", + "Right" + ] + }, "VideoArtifactsConfiguration":{ "type":"structure", "required":["State"], @@ -1856,6 +1974,15 @@ "MuxType":{"shape":"VideoMuxType"} } }, + "VideoAttribute":{ + "type":"structure", + "members":{ + "CornerRadius":{"shape":"CornerRadius"}, + "BorderColor":{"shape":"BorderColor"}, + "HighlightColor":{"shape":"HighlightColor"}, + "BorderThickness":{"shape":"BorderThickness"} + } + }, "VideoConcatenationConfiguration":{ "type":"structure", "required":["State"], @@ -1881,12 +2008,24 @@ "min":1, "pattern":"^[0-9a-zA-Z._-]+" }, + "VocabularyFilterNames":{ + "type":"string", + "max":3000, + "min":1, + "pattern":"^[a-zA-Z0-9,-._]+" + }, "VocabularyName":{ "type":"string", "max":200, "min":1, "pattern":"^[0-9a-zA-Z._-]+" }, + "VocabularyNames":{ + "type":"string", + "max":3000, + "min":1, + "pattern":"^[a-zA-Z0-9,-._]+" + }, "VoiceAnalyticsConfigurationStatus":{ "type":"string", "enum":[ diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json index e1724081adb..6400fa08e68 100644 --- a/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json @@ -23,6 +23,18 @@ "UpdateMediaInsightsPipelineStatus": "Updates the status of a media insights pipeline.
" }, "shapes": { + "ActiveSpeakerOnlyConfiguration": { + "base": "Defines the configuration for an ActiveSpeakerOnly video tile.
The configuration settings for an ActiveSpeakerOnly video tile.
The position of the ActiveSpeakerOnly video tile.
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
For more information, see Partitioning speakers (diarization) in the Amazon Transcribe Developer Guide.
", "AmazonTranscribeProcessorConfiguration$EnablePartialResultsStabilization": "Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
", "AmazonTranscribeProcessorConfiguration$FilterPartialResults": "If true, TranscriptEvents with IsPartial: true are filtered out of the insights target.
Turns language identification on or off.
", "KeywordMatchConfiguration$Negate": "Matches keywords or phrases on their presence or absence. If set to TRUE, the rule matches when all the specified keywords or phrases are absent. Default: FALSE.
Turns off real-time alerts.
" } }, + "BorderColor": { + "base": null, + "refs": { + "VideoAttribute$BorderColor": "Defines the border color of all video tiles.
" + } + }, + "BorderThickness": { + "base": null, + "refs": { + "VideoAttribute$BorderThickness": "Defines the border thickness for all video tiles.
" + } + }, "CallAnalyticsLanguageCode": { "base": null, "refs": { "AmazonTranscribeCallAnalyticsProcessorConfiguration$LanguageCode": "The language code in the configuration.
", - "AmazonTranscribeProcessorConfiguration$LanguageCode": "The language code that represents the language spoken in your audio.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
For a list of languages that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.
" + "AmazonTranscribeProcessorConfiguration$LanguageCode": "The language code that represents the language spoken in your audio.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
For a list of languages that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.
", + "AmazonTranscribeProcessorConfiguration$PreferredLanguage": "The preferred language for the transcription.
" + } + }, + "CanvasOrientation": { + "base": null, + "refs": { + "GridViewConfiguration$CanvasOrientation": "The orientation setting, horizontal or vertical.
" } }, "CategoryName": { @@ -324,6 +356,12 @@ "AmazonTranscribeProcessorConfiguration$ContentRedactionType": "Redacts all personally identifiable information (PII) identified in your transcript.
Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
" } }, + "CornerRadius": { + "base": null, + "refs": { + "VideoAttribute$CornerRadius": "Sets the corner radius of all video tiles.
" + } + }, "CreateMediaCapturePipelineRequest": { "base": null, "refs": { @@ -498,6 +536,24 @@ "MediaPipelineSummary$MediaPipelineId": "The ID of the media pipeline in the summary.
" } }, + "HighlightColor": { + "base": null, + "refs": { + "VideoAttribute$HighlightColor": "Defines the highlight color for the active video tile.
" + } + }, + "HorizontalLayoutConfiguration": { + "base": "Defines the configuration settings for the horizontal layout.
", + "refs": { + "GridViewConfiguration$HorizontalLayoutConfiguration": "The configuration settings for a horizontal layout.
" + } + }, + "HorizontalTilePosition": { + "base": null, + "refs": { + "HorizontalLayoutConfiguration$TilePosition": "Sets the position of horizontal tiles.
" + } + }, "Iso8601Timestamp": { "base": null, "refs": { @@ -569,6 +625,12 @@ "MediaInsightsPipelineConfigurationElement$LambdaFunctionSinkConfiguration": "The configuration settings for the Amazon Web Services Lambda sink in a media insights pipeline configuration element.
" } }, + "LanguageOptions": { + "base": null, + "refs": { + "AmazonTranscribeProcessorConfiguration$LanguageOptions": "The language options for the transcription, such as automatic language detection.
" + } + }, "LayoutOption": { "base": null, "refs": { @@ -985,7 +1047,7 @@ "S3RecordingSinkRuntimeConfiguration": { "base": "A structure that holds the settings for transmitting media files to the Amazon S3 bucket. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.
The runtime configuration for the S3 recording sink.
", + "CreateMediaInsightsPipelineRequest$S3RecordingSinkRuntimeConfiguration": "The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.
The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.
" } }, @@ -1151,6 +1213,27 @@ "refs": { } }, + "TileAspectRatio": { + "base": null, + "refs": { + "HorizontalLayoutConfiguration$TileAspectRatio": "Sets the aspect ratio of the video tiles, such as 16:9.
", + "VerticalLayoutConfiguration$TileAspectRatio": "Sets the aspect ratio of the video tiles, such as 16:9.
" + } + }, + "TileCount": { + "base": null, + "refs": { + "HorizontalLayoutConfiguration$TileCount": "The maximum number of video tiles to display.
", + "VerticalLayoutConfiguration$TileCount": "The maximum number of tiles to display.
" + } + }, + "TileOrder": { + "base": null, + "refs": { + "HorizontalLayoutConfiguration$TileOrder": "Sets the automatic ordering of the video tiles.
", + "VerticalLayoutConfiguration$TileOrder": "Sets the automatic ordering of the video tiles.
" + } + }, "Timestamp": { "base": null, "refs": { @@ -1200,12 +1283,30 @@ "refs": { } }, + "VerticalLayoutConfiguration": { + "base": "Defines the configuration settings for a vertial layout.
", + "refs": { + "GridViewConfiguration$VerticalLayoutConfiguration": "The configuration settings for a vertical layout.
" + } + }, + "VerticalTilePosition": { + "base": null, + "refs": { + "VerticalLayoutConfiguration$TilePosition": "Sets the position of vertical tiles.
" + } + }, "VideoArtifactsConfiguration": { "base": "The video artifact configuration object.
", "refs": { "ArtifactsConfiguration$Video": "The configuration for the video artifacts.
" } }, + "VideoAttribute": { + "base": "Defines the settings for a video tile.
", + "refs": { + "GridViewConfiguration$VideoAttribute": "The attribute settings for the video tiles.
" + } + }, "VideoConcatenationConfiguration": { "base": "The configuration object of a video concatenation pipeline.
", "refs": { @@ -1232,6 +1333,12 @@ "AmazonTranscribeProcessorConfiguration$VocabularyFilterName": "The name of the custom vocabulary filter that you specified in your Call Analytics request.
Length Constraints: Minimum length of 1. Maximum length of 200.
" } }, + "VocabularyFilterNames": { + "base": null, + "refs": { + "AmazonTranscribeProcessorConfiguration$VocabularyFilterNames": "The names of the custom vocabulary filter or filters using during transcription.
" + } + }, "VocabularyName": { "base": null, "refs": { @@ -1239,6 +1346,12 @@ "AmazonTranscribeProcessorConfiguration$VocabularyName": "The name of the custom vocabulary that you specified in your Call Analytics request.
Length Constraints: Minimum length of 1. Maximum length of 200.
" } }, + "VocabularyNames": { + "base": null, + "refs": { + "AmazonTranscribeProcessorConfiguration$VocabularyNames": "The names of the custom vocabulary or vocabularies used during transcription.
" + } + }, "VoiceAnalyticsConfigurationStatus": { "base": null, "refs": { diff --git a/models/apis/cloudformation/2010-05-15/api-2.json b/models/apis/cloudformation/2010-05-15/api-2.json index a6c5b5951f3..b62abd5c0c4 100644 --- a/models/apis/cloudformation/2010-05-15/api-2.json +++ b/models/apis/cloudformation/2010-05-15/api-2.json @@ -665,6 +665,23 @@ "resultWrapper":"ListImportsResult" } }, + "ListStackInstanceResourceDrifts":{ + "name":"ListStackInstanceResourceDrifts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackInstanceResourceDriftsInput"}, + "output":{ + "shape":"ListStackInstanceResourceDriftsOutput", + "resultWrapper":"ListStackInstanceResourceDriftsResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"StackInstanceNotFoundException"}, + {"shape":"OperationNotFoundException"} + ] + }, "ListStackInstances":{ "name":"ListStackInstances", "http":{ @@ -2426,6 +2443,32 @@ "NextToken":{"shape":"NextToken"} } }, + "ListStackInstanceResourceDriftsInput":{ + "type":"structure", + "required":[ + "StackSetName", + "StackInstanceAccount", + "StackInstanceRegion", + "OperationId" + ], + "members":{ + "StackSetName":{"shape":"StackSetNameOrId"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "StackInstanceResourceDriftStatuses":{"shape":"StackResourceDriftStatusFilters"}, + "StackInstanceAccount":{"shape":"Account"}, + "StackInstanceRegion":{"shape":"Region"}, + "OperationId":{"shape":"ClientRequestToken"}, + "CallAs":{"shape":"CallAs"} + } + }, + "ListStackInstanceResourceDriftsOutput":{ + "type":"structure", + "members":{ + "Summaries":{"shape":"StackInstanceResourceDriftsSummaries"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListStackInstancesInput":{ "type":"structure", "required":["StackSetName"], @@ -3517,7 +3560,8 @@ "type":"string", "enum":[ "DETAILED_STATUS", - "LAST_OPERATION_ID" + "LAST_OPERATION_ID", + "DRIFT_STATUS" ] }, "StackInstanceFilterValues":{ @@ -3529,7 +3573,7 @@ "StackInstanceFilters":{ "type":"list", "member":{"shape":"StackInstanceFilter"}, - "max":2 + "max":3 }, "StackInstanceNotFoundException":{ "type":"structure", @@ -3542,6 +3586,30 @@ }, "exception":true }, + "StackInstanceResourceDriftsSummaries":{ + "type":"list", + "member":{"shape":"StackInstanceResourceDriftsSummary"} + }, + "StackInstanceResourceDriftsSummary":{ + "type":"structure", + "required":[ + "StackId", + "LogicalResourceId", + "ResourceType", + "StackResourceDriftStatus", + "Timestamp" + ], + "members":{ + "StackId":{"shape":"StackId"}, + "LogicalResourceId":{"shape":"LogicalResourceId"}, + "PhysicalResourceId":{"shape":"PhysicalResourceId"}, + "PhysicalResourceIdContext":{"shape":"PhysicalResourceIdContext"}, + "ResourceType":{"shape":"ResourceType"}, + "PropertyDifferences":{"shape":"PropertyDifferences"}, + "StackResourceDriftStatus":{"shape":"StackResourceDriftStatus"}, + "Timestamp":{"shape":"Timestamp"} + } + }, "StackInstanceStatus":{ "type":"string", "enum":[ diff --git a/models/apis/cloudformation/2010-05-15/docs-2.json b/models/apis/cloudformation/2010-05-15/docs-2.json index 504ae6f01a1..338b4937450 100644 --- a/models/apis/cloudformation/2010-05-15/docs-2.json +++ b/models/apis/cloudformation/2010-05-15/docs-2.json @@ -46,6 +46,7 @@ "ListChangeSets": "Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see CloudFormation export stack output values.
", "ListImports": "Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
", + "ListStackInstanceResourceDrifts": "Returns drift information for resources in a stack instance.
ListStackInstanceResourceDrifts returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
", "ListStackResources": "Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
", "ListStackSetOperationResults": "Returns summary information about the results of a stack set operation.
", @@ -84,6 +85,7 @@ "refs": { "AccountList$member": null, "DescribeStackInstanceInput$StackInstanceAccount": "The ID of an Amazon Web Services account that's associated with this stack instance.
", + "ListStackInstanceResourceDriftsInput$StackInstanceAccount": "The name of the Amazon Web Services account that you want to list resource drifts for.
", "ListStackInstancesInput$StackInstanceAccount": "The name of the Amazon Web Services account that you want to list stack instances for.
", "StackInstance$Account": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
", "StackInstanceSummary$Account": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
", @@ -260,6 +262,7 @@ "DetectStackSetDriftInput$CallAs": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
For service managed stack sets, specify DELEGATED_ADMIN.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
", "GetTemplateSummaryOutput$Capabilities": "The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
", "Stack$Capabilities": "The capabilities allowed in the stack.
", "StackSet$Capabilities": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
", - "UpdateStackInput$Capabilities": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
" } }, @@ -464,6 +467,7 @@ "ExecuteChangeSetInput$ClientRequestToken": "A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.
A unique, user defined, identifier for the stack set operation.
", "ImportStacksToStackSetOutput$OperationId": "The unique identifier for the stack set operation.
", + "ListStackInstanceResourceDriftsInput$OperationId": "The unique ID of the drift operation.
", "ListStackSetOperationResultsInput$OperationId": "The ID of the stack set operation.
", "RecordHandlerProgressInput$ClientRequestToken": "Reserved for use by the CloudFormation CLI.
", "RollbackStackInput$ClientRequestToken": "A unique identifier for this RollbackStack request.
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
", - "Stack$EnableTerminationProtection": "Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
", + "CreateStackInput$EnableTerminationProtection": "Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
", + "Stack$EnableTerminationProtection": "Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
", "UpdateTerminationProtectionInput$EnableTerminationProtection": "Whether to enable termination protection on the specified stack.
" } }, @@ -1249,6 +1253,16 @@ "refs": { } }, + "ListStackInstanceResourceDriftsInput": { + "base": null, + "refs": { + } + }, + "ListStackInstanceResourceDriftsOutput": { + "base": null, + "refs": { + } + }, "ListStackInstancesInput": { "base": null, "refs": { @@ -1373,6 +1387,7 @@ "RetainResources$member": null, "SignalResourceInput$LogicalResourceId": "The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.
", "StackEvent$LogicalResourceId": "The logical name of the resource specified in the template.
", + "StackInstanceResourceDriftsSummary$LogicalResourceId": "The logical name of the resource specified in the template.
", "StackResource$LogicalResourceId": "The logical name of the resource specified in the template.
", "StackResourceDetail$LogicalResourceId": "The logical name of the resource specified in the template.
", "StackResourceDrift$LogicalResourceId": "The logical name of the resource specified in the template.
", @@ -1422,6 +1437,7 @@ "MaxResults": { "base": null, "refs": { + "ListStackInstanceResourceDriftsInput$MaxResults": "The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.
", "ListImportsInput$NextToken": "A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.
", "ListImportsOutput$NextToken": "A string that identifies the next page of exports. If there is no additional page, this value is null.
", + "ListStackInstanceResourceDriftsInput$NextToken": "If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
A string that identifies the next page of stack resources that you want to retrieve.
", @@ -1720,6 +1738,7 @@ "DescribeStackResourcesInput$PhysicalResourceId": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must specify StackName.
Default: There is no default value.
", "ResourceChange$PhysicalResourceId": "The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
", "StackEvent$PhysicalResourceId": "The name or unique identifier associated with the physical instance of the resource.
", + "StackInstanceResourceDriftsSummary$PhysicalResourceId": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
", "StackResource$PhysicalResourceId": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
", "StackResourceDetail$PhysicalResourceId": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
", "StackResourceDrift$PhysicalResourceId": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
", @@ -1729,6 +1748,7 @@ "PhysicalResourceIdContext": { "base": null, "refs": { + "StackInstanceResourceDriftsSummary$PhysicalResourceIdContext": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
", "StackResourceDrift$PhysicalResourceIdContext": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
" } }, @@ -1764,6 +1784,7 @@ "PropertyDifferences": { "base": null, "refs": { + "StackInstanceResourceDriftsSummary$PropertyDifferences": "Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose StackInstanceResourceDriftStatus is MODIFIED.
A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.
The name of a Region that's associated with this stack instance.
", + "ListStackInstanceResourceDriftsInput$StackInstanceRegion": "The name of the Region where you want to list resource drifts.
", "ListStackInstancesInput$StackInstanceRegion": "The name of the Region where you want to list stack instances.
", "RegionList$member": null, "StackInstance$Region": "The name of the Amazon Web Services Region that the stack instance is associated with.
", @@ -2110,6 +2132,7 @@ "ResourceToImport$ResourceType": "The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the CloudFormation User Guide.
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
", + "StackInstanceResourceDriftsSummary$ResourceType": "Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
", "StackResource$ResourceType": "Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
", "StackResourceDetail$ResourceType": "Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
", "StackResourceDrift$ResourceType": "The type of the resource.
", @@ -2168,14 +2191,14 @@ "ContinueUpdateRollbackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
", "CreateChangeSetInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
", "CreateStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
", - "CreateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", + "CreateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", "DeleteStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
", "RollbackStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.
", "Stack$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
", - "StackSet$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", - "StackSetOperation$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
", + "StackSet$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", + "StackSetOperation$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
", "UpdateStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
", - "UpdateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
" + "UpdateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
" } }, "RoleArn": { @@ -2188,7 +2211,7 @@ } }, "RollbackConfiguration": { - "base": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.
", + "base": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.
", "refs": { "CreateChangeSetInput$RollbackConfiguration": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
", "CreateStackInput$RollbackConfiguration": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
", @@ -2296,13 +2319,13 @@ "StackDriftInformation": { "base": "Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.
", "refs": { - "Stack$DriftInformation": "Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "Stack$DriftInformation": "Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "StackDriftInformationSummary": { "base": "Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.
", "refs": { - "StackSummary$DriftInformation": "Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "StackSummary$DriftInformation": "Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "StackDriftStatus": { @@ -2341,18 +2364,19 @@ "Export$ExportingStackId": "The stack that contains the exported output name and value.
", "RollbackStackOutput$StackId": "Unique identifier of the stack.
", "Stack$StackId": "Unique identifier of the stack.
", - "Stack$ParentId": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", - "Stack$RootId": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", + "Stack$ParentId": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", + "Stack$RootId": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", "StackEvent$StackId": "The unique ID name of the instance of the stack.
", "StackIdList$member": null, "StackInstance$StackId": "The ID of the stack instance.
", + "StackInstanceResourceDriftsSummary$StackId": "The ID of the stack instance.
", "StackInstanceSummary$StackId": "The ID of the stack instance.
", "StackResource$StackId": "Unique identifier of the stack.
", "StackResourceDetail$StackId": "Unique identifier of the stack.
", "StackResourceDrift$StackId": "The ID of the stack.
", "StackSummary$StackId": "Unique stack identifier.
", - "StackSummary$ParentId": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", - "StackSummary$RootId": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", + "StackSummary$ParentId": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", + "StackSummary$RootId": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
", "UpdateStackOutput$StackId": "Unique identifier of the stack.
", "UpdateTerminationProtectionOutput$StackId": "The unique ID of the stack.
" } @@ -2417,6 +2441,18 @@ "refs": { } }, + "StackInstanceResourceDriftsSummaries": { + "base": null, + "refs": { + "ListStackInstanceResourceDriftsOutput$Summaries": "A list of StackInstanceResourceDriftSummary structures that contain information about the specified stack instances.
The structure containing summary information about resource drifts for a stack instance.
", + "refs": { + "StackInstanceResourceDriftsSummaries$member": null + } + }, "StackInstanceStatus": { "base": null, "refs": { @@ -2528,7 +2564,7 @@ } }, "StackResourceDrift": { - "base": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
", + "base": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
", "refs": { "DetectStackResourceDriftOutput$StackResourceDrift": "Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.
", "StackResourceDrifts$member": null @@ -2537,19 +2573,20 @@ "StackResourceDriftInformation": { "base": "Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
", "refs": { - "StackResource$DriftInformation": "Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
", - "StackResourceDetail$DriftInformation": "Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "StackResource$DriftInformation": "Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
", + "StackResourceDetail$DriftInformation": "Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "StackResourceDriftInformationSummary": { "base": "Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
", "refs": { - "StackResourceSummary$DriftInformation": "Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "StackResourceSummary$DriftInformation": "Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "StackResourceDriftStatus": { "base": null, "refs": { + "StackInstanceResourceDriftsSummary$StackResourceDriftStatus": "The drift status of the resource in a stack instance.
DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
MODIFIED: One or more resource properties differ from their expected template values.
IN_SYNC: The resource's actual configuration matches its expected template configuration.
NOT_CHECKED: CloudFormation doesn't currently return this value.
Status of the resource's actual configuration compared to its expected configuration.
DELETED: The resource differs from its expected template configuration because the resource has been deleted.
MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).
IN_SYNC: The resource's actual configuration matches its expected template configuration.
NOT_CHECKED: CloudFormation does not currently return this value.
Status of the resource's actual configuration compared to its expected configuration
DELETED: The resource differs from its expected configuration in that it has been deleted.
MODIFIED: The resource differs from its expected configuration.
NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection.
IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration.
DELETED: The resource differs from its expected configuration in that it has been deleted.
MODIFIED: The resource differs from its expected configuration.
NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.
Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
IN_SYNC: The resource's actual configuration matches its expected configuration.
The resource drift status values to use as filters for the resource drift results returned.
DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
MODIFIED: One or more resource properties differ from their expected template values.
IN_SYNC: The resource's actual configuration matches its expected template configuration.
NOT_CHECKED: CloudFormation doesn't currently return this value.
The resource drift status values to use as filters for the resource drift results returned.
DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
MODIFIED: One or more resource properties differ from their expected template values.
IN_SYNC: The resource's actual configuration matches its expected template configuration.
NOT_CHECKED: CloudFormation doesn't currently return this value.
The resource drift status of the stack instance.
DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
MODIFIED: One or more resource properties differ from their expected template values.
IN_SYNC: The resource's actual configuration matches its expected template configuration.
NOT_CHECKED: CloudFormation doesn't currently return this value.
The name of the stack set on which to perform the drift detection operation.
", "GetTemplateSummaryInput$StackSetName": "The name or unique ID of the stack set from which the stack was created.
Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
The name of the stack set. The name must be unique in the Region where you create your stack set.
", + "ListStackInstanceResourceDriftsInput$StackSetName": "The name or unique ID of the stack set that you want to list drifted resources for.
", "UpdateStackInstancesInput$StackSetName": "The name or unique ID of the stack set associated with the stack instances.
" } }, @@ -2975,6 +3014,7 @@ "StackDriftInformationSummary$LastCheckTimestamp": "Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
", "StackEvent$Timestamp": "Time the status was updated.
", "StackInstance$LastDriftCheckTimestamp": "Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.
Time at which the stack instance drift detection operation was initiated.
", "StackInstanceSummary$LastDriftCheckTimestamp": "Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.
Time the status was updated.
", "StackResourceDetail$LastUpdatedTimestamp": "Time the status was updated.
", diff --git a/models/apis/cloudformation/2010-05-15/endpoint-tests-1.json b/models/apis/cloudformation/2010-05-15/endpoint-tests-1.json index b20e6d8f1e7..dcd0159a381 100644 --- a/models/apis/cloudformation/2010-05-15/endpoint-tests-1.json +++ b/models/apis/cloudformation/2010-05-15/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "Region": "af-south-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "af-south-1" } }, { @@ -21,9 +21,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-east-1" } }, { @@ -34,9 +34,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-northeast-1" } }, { @@ -47,9 +47,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-northeast-2" } }, { @@ -60,9 +60,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-northeast-3" } }, { @@ -73,9 +73,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-south-1" } }, { @@ -86,9 +86,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-southeast-1" } }, { @@ -99,9 +99,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-southeast-2" } }, { @@ -112,9 +112,9 @@ } }, "params": { - "Region": "ap-southeast-3", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ap-southeast-3" } }, { @@ -125,9 +125,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "ca-central-1" } }, { @@ -138,9 +138,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "eu-central-1" } }, { @@ -151,9 +151,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "eu-north-1" } }, { @@ -164,9 +164,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "eu-south-1" } }, { @@ -177,9 +177,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "eu-west-1" } }, { @@ -190,9 +190,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "eu-west-2" } }, { @@ -203,9 +203,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "eu-west-3" } }, { @@ -216,9 +216,9 @@ } }, "params": { - "Region": "me-south-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "me-south-1" } }, { @@ -229,9 +229,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "sa-east-1" } }, { @@ -242,9 +242,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -255,9 +255,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -268,9 +268,9 @@ } }, "params": { - "Region": "us-east-2", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-east-2" } }, { @@ -281,9 +281,9 @@ } }, "params": { - "Region": "us-east-2", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-east-2" } }, { @@ -294,9 +294,9 @@ } }, "params": { - "Region": "us-west-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-west-1" } }, { @@ -307,9 +307,9 @@ } }, "params": { - "Region": "us-west-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-west-1" } }, { @@ -320,9 +320,9 @@ } }, "params": { - "Region": "us-west-2", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -333,9 +333,9 @@ } }, "params": { - "Region": "us-west-2", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -346,9 +346,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -359,9 +359,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -372,9 +372,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "cn-north-1" } }, { @@ -385,9 +385,9 @@ } }, "params": { - "Region": "cn-northwest-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "cn-northwest-1" } }, { @@ -398,9 +398,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "cn-north-1" } }, { @@ -411,9 +411,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "cn-north-1" } }, { @@ -424,9 +424,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "cn-north-1" } }, { @@ -437,9 +437,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-gov-east-1" } }, { @@ -450,9 +450,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-gov-east-1" } }, { @@ -463,9 +463,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-gov-west-1" } }, { @@ -476,9 +476,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-gov-west-1" } }, { @@ -489,9 +489,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-gov-east-1" } }, { @@ -502,9 +502,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-gov-east-1" } }, { @@ -515,9 +515,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-iso-east-1" } }, { @@ -528,9 +528,9 @@ } }, "params": { - "Region": "us-iso-west-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-iso-west-1" } }, { @@ -539,9 +539,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-iso-east-1" } }, { @@ -552,9 +552,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-iso-east-1" } }, { @@ -563,9 +563,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-iso-east-1" } }, { @@ -576,9 +576,9 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-isob-east-1" } }, { @@ -587,9 +587,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-isob-east-1" } }, { @@ -600,9 +600,9 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-isob-east-1" } }, { @@ -611,9 +611,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-isob-east-1" } }, { @@ -624,9 +624,9 @@ } }, "params": { - "Region": "us-east-1", - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -638,8 +638,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -649,9 +649,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -661,9 +661,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index fb378010509..78a1331a5ef 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -39568,7 +39568,8 @@ "active", "closed", "cancelled", - "failed" + "failed", + "disabled" ] }, "SpotInstanceStateFault":{ diff --git a/models/apis/glue/2017-03-31/api-2.json b/models/apis/glue/2017-03-31/api-2.json index b669b43885a..3b90178c9d3 100644 --- a/models/apis/glue/2017-03-31/api-2.json +++ b/models/apis/glue/2017-03-31/api-2.json @@ -4268,7 +4268,8 @@ "S3DeltaDirectTarget":{"shape":"S3DeltaDirectTarget"}, "AmazonRedshiftSource":{"shape":"AmazonRedshiftSource"}, "AmazonRedshiftTarget":{"shape":"AmazonRedshiftTarget"}, - "EvaluateDataQualityMultiFrame":{"shape":"EvaluateDataQualityMultiFrame"} + "EvaluateDataQualityMultiFrame":{"shape":"EvaluateDataQualityMultiFrame"}, + "Recipe":{"shape":"Recipe"} } }, "CodeGenConfigurationNodes":{ @@ -10068,6 +10069,35 @@ "disabled" ] }, + "Recipe":{ + "type":"structure", + "required":[ + "Name", + "Inputs", + "RecipeReference" + ], + "members":{ + "Name":{"shape":"NodeName"}, + "Inputs":{"shape":"OneInput"}, + "RecipeReference":{"shape":"RecipeReference"} + } + }, + "RecipeReference":{ + "type":"structure", + "required":[ + "RecipeArn", + "RecipeVersion" + ], + "members":{ + "RecipeArn":{"shape":"EnclosedInStringProperty"}, + "RecipeVersion":{"shape":"RecipeVersion"} + } + }, + "RecipeVersion":{ + "type":"string", + "max":16, + "min":1 + }, "RecordsCount":{ "type":"long", "box":true diff --git a/models/apis/glue/2017-03-31/docs-2.json b/models/apis/glue/2017-03-31/docs-2.json index 036f1dbf9d7..e0eb9b30f2f 100644 --- a/models/apis/glue/2017-03-31/docs-2.json +++ b/models/apis/glue/2017-03-31/docs-2.json @@ -2867,6 +2867,7 @@ "PostgreSQLCatalogSource$Table": "The name of the table in the database to read from.
", "PostgreSQLCatalogTarget$Database": "The name of the database to write to.
", "PostgreSQLCatalogTarget$Table": "The name of the table in the database to write to.
", + "RecipeReference$RecipeArn": "The ARN of the DataBrew recipe.
", "RedshiftSource$Database": "The database to read from.
", "RedshiftSource$Table": "The database table to read from.
", "RedshiftSource$RedshiftTmpDir": "The Amazon S3 path where temporary data can be staged when copying out of the database.
", @@ -5713,6 +5714,7 @@ "PIIDetection$Name": "The name of the transform node.
", "PostgreSQLCatalogSource$Name": "The name of the data source.
", "PostgreSQLCatalogTarget$Name": "The name of the data target.
", + "Recipe$Name": "The name of the Glue Studio node.
", "RedshiftSource$Name": "The name of the Amazon Redshift data store.
", "RedshiftTarget$Name": "The name of the data target.
", "RelationalCatalogSource$Name": "The name of the data source.
", @@ -5939,6 +5941,7 @@ "OracleSQLCatalogTarget$Inputs": "The nodes that are inputs to the data target.
", "PIIDetection$Inputs": "The node ID inputs to the transform.
", "PostgreSQLCatalogTarget$Inputs": "The nodes that are inputs to the data target.
", + "Recipe$Inputs": "The nodes that are inputs to the recipe node, identified by id.
", "RedshiftTarget$Inputs": "The nodes that are inputs to the data target.
", "RenameField$Inputs": "The data inputs identified by their node names.
", "S3CatalogTarget$Inputs": "The nodes that are inputs to the data target.
", @@ -6525,6 +6528,24 @@ "S3CsvSource$QuoteChar": "Specifies the character to use for quoting. The default is a double quote: '\"'. Set this to -1 to turn off quoting entirely.
A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs.
", + "refs": { + "CodeGenConfigurationNode$Recipe": "Specifies a Glue DataBrew recipe node.
" + } + }, + "RecipeReference": { + "base": "A reference to a Glue DataBrew recipe.
", + "refs": { + "Recipe$RecipeReference": "A reference to the DataBrew recipe used by the node.
" + } + }, + "RecipeVersion": { + "base": null, + "refs": { + "RecipeReference$RecipeVersion": "The RecipeVersion of the DataBrew recipe.
" + } + }, "RecordsCount": { "base": null, "refs": { diff --git a/models/apis/quicksight/2018-04-01/api-2.json b/models/apis/quicksight/2018-04-01/api-2.json index 6f89bbe0c26..72122980e18 100644 --- a/models/apis/quicksight/2018-04-01/api-2.json +++ b/models/apis/quicksight/2018-04-01/api-2.json @@ -445,6 +445,8 @@ {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"PreconditionNotMetException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ] @@ -1018,6 +1020,40 @@ {"shape":"InternalFailureException"} ] }, + "DescribeDashboardSnapshotJob":{ + "name":"DescribeDashboardSnapshotJob", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}" + }, + "input":{"shape":"DescribeDashboardSnapshotJobRequest"}, + "output":{"shape":"DescribeDashboardSnapshotJobResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "DescribeDashboardSnapshotJobResult":{ + "name":"DescribeDashboardSnapshotJobResult", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result" + }, + "input":{"shape":"DescribeDashboardSnapshotJobResultRequest"}, + "output":{"shape":"DescribeDashboardSnapshotJobResultResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"} + ] + }, "DescribeDataSet":{ "name":"DescribeDataSet", "http":{ @@ -2258,6 +2294,26 @@ {"shape":"ResourceNotFoundException"} ] }, + "StartDashboardSnapshotJob":{ + "name":"StartDashboardSnapshotJob", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs" + }, + "input":{"shape":"StartDashboardSnapshotJobRequest"}, + "output":{"shape":"StartDashboardSnapshotJobResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"UnsupportedPricingPlanException"}, + {"shape":"InternalFailureException"} + ] + }, "TagResource":{ "name":"TagResource", "http":{ @@ -2886,7 +2942,8 @@ "members":{ "NumericalAggregationFunction":{"shape":"NumericalAggregationFunction"}, "CategoricalAggregationFunction":{"shape":"CategoricalAggregationFunction"}, - "DateAggregationFunction":{"shape":"DateAggregationFunction"} + "DateAggregationFunction":{"shape":"DateAggregationFunction"}, + "AttributeAggregationFunction":{"shape":"AttributeAggregationFunction"} } }, "AggregationFunctionParameters":{ @@ -3098,6 +3155,16 @@ "InitialTopicId":{"shape":"RestrictiveResourceId"} } }, + "AnonymousUserSnapshotJobResult":{ + "type":"structure", + "members":{ + "FileGroups":{"shape":"SnapshotJobResultFileGroupList"} + } + }, + "AnonymousUserSnapshotJobResultList":{ + "type":"list", + "member":{"shape":"AnonymousUserSnapshotJobResult"} + }, "ArcAxisConfiguration":{ "type":"structure", "members":{ @@ -3642,6 +3709,13 @@ "RoleArn":{"shape":"RoleArn"} } }, + "AttributeAggregationFunction":{ + "type":"structure", + "members":{ + "SimpleAttributeAggregation":{"shape":"SimpleAttributeAggregationFunction"}, + "ValueForMultipleValues":{"shape":"String"} + } + }, "AuroraParameters":{ "type":"structure", "required":[ @@ -6739,7 +6813,8 @@ "type":"structure", "members":{ "TitleOptions":{"shape":"LabelOptions"}, - "DateTimeFormat":{"shape":"DateTimeFormat"} + "DateTimeFormat":{"shape":"DateTimeFormat"}, + "InfoIconLabelOptions":{"shape":"SheetControlInfoIconLabelOptions"} } }, "DateTimeValueWhenUnsetConfiguration":{ @@ -8085,6 +8160,88 @@ "RequestId":{"shape":"String"} } }, + "DescribeDashboardSnapshotJobRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "DashboardId", + "SnapshotJobId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "DashboardId":{ + "shape":"ShortRestrictiveResourceId", + "location":"uri", + "locationName":"DashboardId" + }, + "SnapshotJobId":{ + "shape":"ShortRestrictiveResourceId", + "location":"uri", + "locationName":"SnapshotJobId" + } + } + }, + "DescribeDashboardSnapshotJobResponse":{ + "type":"structure", + "members":{ + "AwsAccountId":{"shape":"AwsAccountId"}, + "DashboardId":{"shape":"ShortRestrictiveResourceId"}, + "SnapshotJobId":{"shape":"ShortRestrictiveResourceId"}, + "UserConfiguration":{"shape":"SnapshotUserConfigurationRedacted"}, + "SnapshotConfiguration":{"shape":"SnapshotConfiguration"}, + "Arn":{"shape":"Arn"}, + "JobStatus":{"shape":"SnapshotJobStatus"}, + "CreatedTime":{"shape":"Timestamp"}, + "LastUpdatedTime":{"shape":"Timestamp"}, + "RequestId":{"shape":"NonEmptyString"}, + "Status":{"shape":"StatusCode"} + } + }, + "DescribeDashboardSnapshotJobResultRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "DashboardId", + "SnapshotJobId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "DashboardId":{ + "shape":"ShortRestrictiveResourceId", + "location":"uri", + "locationName":"DashboardId" + }, + "SnapshotJobId":{ + "shape":"ShortRestrictiveResourceId", + "location":"uri", + "locationName":"SnapshotJobId" + } + } + }, + "DescribeDashboardSnapshotJobResultResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "JobStatus":{"shape":"SnapshotJobStatus"}, + "CreatedTime":{"shape":"Timestamp"}, + "LastUpdatedTime":{"shape":"Timestamp"}, + "Result":{"shape":"SnapshotJobResult"}, + "ErrorInfo":{"shape":"SnapshotJobErrorInfo"}, + "RequestId":{"shape":"NonEmptyString"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, "DescribeDataSetPermissionsRequest":{ "type":"structure", "required":[ @@ -9138,7 +9295,8 @@ "type":"structure", "members":{ "SelectAllOptions":{"shape":"ListControlSelectAllOptions"}, - "TitleOptions":{"shape":"LabelOptions"} + "TitleOptions":{"shape":"LabelOptions"}, + "InfoIconLabelOptions":{"shape":"SheetControlInfoIconLabelOptions"} } }, "DynamicDefaultValue":{ @@ -11689,7 +11847,8 @@ "members":{ "SearchOptions":{"shape":"ListControlSearchOptions"}, "SelectAllOptions":{"shape":"ListControlSelectAllOptions"}, - "TitleOptions":{"shape":"LabelOptions"} + "TitleOptions":{"shape":"LabelOptions"}, + "InfoIconLabelOptions":{"shape":"SheetControlInfoIconLabelOptions"} } }, "ListControlSearchOptions":{ @@ -14610,7 +14769,8 @@ "type":"structure", "members":{ "TitleOptions":{"shape":"LabelOptions"}, - "DateTimeFormat":{"shape":"DateTimeFormat"} + "DateTimeFormat":{"shape":"DateTimeFormat"}, + "InfoIconLabelOptions":{"shape":"SheetControlInfoIconLabelOptions"} } }, "RelativeDateType":{ @@ -14915,6 +15075,19 @@ "max":1024, "min":1 }, + "S3BucketConfiguration":{ + "type":"structure", + "required":[ + "BucketName", + "BucketPrefix", + "BucketRegion" + ], + "members":{ + "BucketName":{"shape":"NonEmptyString"}, + "BucketPrefix":{"shape":"NonEmptyString"}, + "BucketRegion":{"shape":"NonEmptyString"} + } + }, "S3Key":{ "type":"string", "max":1024, @@ -15425,6 +15598,11 @@ "type":"long", "sensitive":true }, + "SensitiveS3Uri":{ + "type":"string", + "pattern":"^(https|s3)://([^/]+)/?(.*)$", + "sensitive":true + }, "SensitiveString":{ "type":"string", "sensitive":true @@ -15494,6 +15672,12 @@ "max":128, "min":1 }, + "SessionTagKeyList":{ + "type":"list", + "member":{"shape":"SessionTagKey"}, + "max":50, + "min":1 + }, "SessionTagList":{ "type":"list", "member":{"shape":"SessionTag"}, @@ -15551,6 +15735,18 @@ "DATE_RANGE" ] }, + "SheetControlInfoIconLabelOptions":{ + "type":"structure", + "members":{ + "Visibility":{"shape":"Visibility"}, + "InfoIconText":{"shape":"SheetControlInfoIconText"} + } + }, + "SheetControlInfoIconText":{ + "type":"string", + "max":100, + "min":1 + }, "SheetControlLayout":{ "type":"structure", "required":["Configuration"], @@ -15739,6 +15935,10 @@ "directoryType":{"shape":"String"} } }, + "SimpleAttributeAggregationFunction":{ + "type":"string", + "enum":["UNIQUE_VALUE"] + }, "SimpleClusterMarker":{ "type":"structure", "members":{ @@ -15769,7 +15969,8 @@ "SliderControlDisplayOptions":{ "type":"structure", "members":{ - "TitleOptions":{"shape":"LabelOptions"} + "TitleOptions":{"shape":"LabelOptions"}, + "InfoIconLabelOptions":{"shape":"SheetControlInfoIconLabelOptions"} } }, "SmallMultiplesAxisPlacement":{ @@ -15808,6 +16009,192 @@ "YAxis":{"shape":"SmallMultiplesAxisProperties"} } }, + "SnapshotAnonymousUser":{ + "type":"structure", + "members":{ + "RowLevelPermissionTags":{"shape":"SessionTagList"} + } + }, + "SnapshotAnonymousUserList":{ + "type":"list", + "member":{"shape":"SnapshotAnonymousUser"}, + "max":1, + "min":1 + }, + "SnapshotAnonymousUserRedacted":{ + "type":"structure", + "members":{ + "RowLevelPermissionTagKeys":{"shape":"SessionTagKeyList"} + } + }, + "SnapshotAnonymousUserRedactedList":{ + "type":"list", + "member":{"shape":"SnapshotAnonymousUserRedacted"}, + "max":1, + "min":1 + }, + "SnapshotConfiguration":{ + "type":"structure", + "required":["FileGroups"], + "members":{ + "FileGroups":{"shape":"SnapshotFileGroupList"}, + "DestinationConfiguration":{"shape":"SnapshotDestinationConfiguration"}, + "Parameters":{"shape":"Parameters"} + } + }, + "SnapshotDestinationConfiguration":{ + "type":"structure", + "members":{ + "S3Destinations":{"shape":"SnapshotS3DestinationConfigurationList"} + } + }, + "SnapshotFile":{ + "type":"structure", + "required":[ + "SheetSelections", + "FormatType" + ], + "members":{ + "SheetSelections":{"shape":"SnapshotFileSheetSelectionList"}, + "FormatType":{"shape":"SnapshotFileFormatType"} + } + }, + "SnapshotFileFormatType":{ + "type":"string", + "enum":[ + "CSV", + "PDF" + ] + }, + "SnapshotFileGroup":{ + "type":"structure", + "members":{ + "Files":{"shape":"SnapshotFileList"} + } + }, + "SnapshotFileGroupList":{ + "type":"list", + "member":{"shape":"SnapshotFileGroup"}, + "max":6, + "min":1 + }, + "SnapshotFileList":{ + "type":"list", + "member":{"shape":"SnapshotFile"}, + "max":1, + "min":1 + }, + "SnapshotFileSheetSelection":{ + "type":"structure", + "required":[ + "SheetId", + "SelectionScope" + ], + "members":{ + "SheetId":{"shape":"ShortRestrictiveResourceId"}, + "SelectionScope":{"shape":"SnapshotFileSheetSelectionScope"}, + "VisualIds":{"shape":"SnapshotFileSheetSelectionVisualIdList"} + } + }, + "SnapshotFileSheetSelectionList":{ + "type":"list", + "member":{"shape":"SnapshotFileSheetSelection"}, + "max":1, + "min":1 + }, + "SnapshotFileSheetSelectionScope":{ + "type":"string", + "enum":[ + "ALL_VISUALS", + "SELECTED_VISUALS" + ] + }, + "SnapshotFileSheetSelectionVisualIdList":{ + "type":"list", + "member":{"shape":"ShortRestrictiveResourceId"}, + "max":1, + "min":1 + }, + "SnapshotJobErrorInfo":{ + "type":"structure", + "members":{ + "ErrorMessage":{"shape":"String"}, + "ErrorType":{"shape":"String"} + } + }, + "SnapshotJobResult":{ + "type":"structure", + "members":{ + "AnonymousUsers":{"shape":"AnonymousUserSnapshotJobResultList"} + } + }, + "SnapshotJobResultErrorInfo":{ + "type":"structure", + "members":{ + "ErrorMessage":{"shape":"String"}, + "ErrorType":{"shape":"String"} + } + }, + "SnapshotJobResultErrorInfoList":{ + "type":"list", + "member":{"shape":"SnapshotJobResultErrorInfo"} + }, + "SnapshotJobResultFileGroup":{ + "type":"structure", + "members":{ + "Files":{"shape":"SnapshotFileList"}, + "S3Results":{"shape":"SnapshotJobS3ResultList"} + } + }, + "SnapshotJobResultFileGroupList":{ + "type":"list", + "member":{"shape":"SnapshotJobResultFileGroup"} + }, + "SnapshotJobS3Result":{ + "type":"structure", + "members":{ + "S3DestinationConfiguration":{"shape":"SnapshotS3DestinationConfiguration"}, + "S3Uri":{"shape":"SensitiveS3Uri"}, + "ErrorInfo":{"shape":"SnapshotJobResultErrorInfoList"} + } + }, + "SnapshotJobS3ResultList":{ + "type":"list", + "member":{"shape":"SnapshotJobS3Result"} + }, + "SnapshotJobStatus":{ + "type":"string", + "enum":[ + "QUEUED", + "RUNNING", + "COMPLETED", + "FAILED" + ] + }, + "SnapshotS3DestinationConfiguration":{ + "type":"structure", + "members":{ + "BucketConfiguration":{"shape":"S3BucketConfiguration"} + } + }, + "SnapshotS3DestinationConfigurationList":{ + "type":"list", + "member":{"shape":"SnapshotS3DestinationConfiguration"}, + "max":1, + "min":1 + }, + "SnapshotUserConfiguration":{ + "type":"structure", + "members":{ + "AnonymousUsers":{"shape":"SnapshotAnonymousUserList"} + } + }, + "SnapshotUserConfigurationRedacted":{ + "type":"structure", + "members":{ + "AnonymousUsers":{"shape":"SnapshotAnonymousUserRedactedList"} + } + }, "SnowflakeParameters":{ "type":"structure", "required":[ @@ -15949,6 +16336,43 @@ } } }, + "StartDashboardSnapshotJobRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "DashboardId", + "SnapshotJobId", + "UserConfiguration", + "SnapshotConfiguration" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "DashboardId":{ + "shape":"ShortRestrictiveResourceId", + "location":"uri", + "locationName":"DashboardId" + }, + "SnapshotJobId":{"shape":"ShortRestrictiveResourceId"}, + "UserConfiguration":{"shape":"SnapshotUserConfiguration"}, + "SnapshotConfiguration":{"shape":"SnapshotConfiguration"} + } + }, + "StartDashboardSnapshotJobResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "SnapshotJobId":{"shape":"ShortRestrictiveResourceId"}, + "RequestId":{"shape":"NonEmptyString"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, "StatePersistenceConfigurations":{ "type":"structure", "required":["Enabled"], @@ -16592,7 +17016,8 @@ "type":"structure", "members":{ "TitleOptions":{"shape":"LabelOptions"}, - "PlaceholderOptions":{"shape":"TextControlPlaceholderOptions"} + "PlaceholderOptions":{"shape":"TextControlPlaceholderOptions"}, + "InfoIconLabelOptions":{"shape":"SheetControlInfoIconLabelOptions"} } }, "TextConditionalFormat":{ @@ -16613,7 +17038,8 @@ "type":"structure", "members":{ "TitleOptions":{"shape":"LabelOptions"}, - "PlaceholderOptions":{"shape":"TextControlPlaceholderOptions"} + "PlaceholderOptions":{"shape":"TextControlPlaceholderOptions"}, + "InfoIconLabelOptions":{"shape":"SheetControlInfoIconLabelOptions"} } }, "TextQualifier":{ diff --git a/models/apis/quicksight/2018-04-01/docs-2.json b/models/apis/quicksight/2018-04-01/docs-2.json index e51ee3164f3..543d176bb0b 100644 --- a/models/apis/quicksight/2018-04-01/docs-2.json +++ b/models/apis/quicksight/2018-04-01/docs-2.json @@ -58,6 +58,8 @@ "DescribeDashboard": "Provides a summary for a dashboard.
", "DescribeDashboardDefinition": "Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
Describes read and write permissions for a dashboard.
", + "DescribeDashboardSnapshotJob": "Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.
If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
", "DescribeDataSetPermissions": "Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Describes the refresh properties of a dataset.
", @@ -129,6 +131,7 @@ "SearchGroups": "Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
", "StartAssetBundleImportJob": "Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
Starts an asynchronous job that generates a dashboard snapshot. You can request up to one paginated PDF and up to five CSVs per API call.
Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, and topic.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
Removes a tag or tags from a resource.
", "UpdateAccountCustomization": "Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
The Q search bar that you want to use for anonymous user embedding.
" } }, + "AnonymousUserSnapshotJobResult": { + "base": "A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.
A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.
The arc axis configuration of a GaugeChartVisual.
The Amazon Resource Name (ARN) for the import job.
", "DescribeDashboardDefinitionResponse$ThemeArn": "The ARN of the theme of the dashboard.
", "DescribeDashboardPermissionsResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
", + "DescribeDashboardSnapshotJobResponse$Arn": "The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
The Amazon Resource Name (ARN) of the dataset.
", "DescribeDataSourcePermissionsResponse$DataSourceArn": "The Amazon Resource Name (ARN) of the data source.
", "DescribeFolderPermissionsResponse$Arn": "The Amazon Resource Name (ARN) for the folder.
", @@ -572,6 +589,7 @@ "S3Source$DataSourceArn": "The Amazon Resource Name (ARN) for the data source.
", "StartAssetBundleExportJobResponse$Arn": "The Amazon Resource Name (ARN) for the export job.
", "StartAssetBundleImportJobResponse$Arn": "The Amazon Resource Name (ARN) for the import job.
", + "StartDashboardSnapshotJobResponse$Arn": "The Amazon Resource Name (ARN) for the dashboard snapshot job.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want to tag.
", "Template$Arn": "The Amazon Resource Name (ARN) of the template.
", "TemplateAlias$Arn": "The Amazon Resource Name (ARN) of the template alias.
", @@ -1045,6 +1063,12 @@ "DataSourceParameters$AthenaParameters": "The parameters for Amazon Athena.
" } }, + "AttributeAggregationFunction": { + "base": "Aggregation for attributes.
", + "refs": { + "AggregationFunction$AttributeAggregationFunction": "Aggregation for attributes.
" + } + }, "AuroraParameters": { "base": "Parameters for Amazon Aurora.
", "refs": { @@ -1141,6 +1165,9 @@ "DescribeDashboardDefinitionRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the dashboard that you're describing.
", "DescribeDashboardPermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.
", "DescribeDashboardRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the dashboard that you're describing.
", + "DescribeDashboardSnapshotJobRequest$AwsAccountId": "The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
", + "DescribeDashboardSnapshotJobResponse$AwsAccountId": "The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
", + "DescribeDashboardSnapshotJobResultRequest$AwsAccountId": "The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
", "DescribeDataSetPermissionsRequest$AwsAccountId": "The Amazon Web Services account ID.
", "DescribeDataSetRefreshPropertiesRequest$AwsAccountId": "The Amazon Web Services account ID.
", "DescribeDataSetRequest$AwsAccountId": "The Amazon Web Services account ID.
", @@ -1212,6 +1239,7 @@ "SearchGroupsRequest$AwsAccountId": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
", "StartAssetBundleExportJobRequest$AwsAccountId": "The ID of the Amazon Web Services account to export assets from.
", "StartAssetBundleImportJobRequest$AwsAccountId": "The ID of the Amazon Web Services account to import assets into.
", + "StartDashboardSnapshotJobRequest$AwsAccountId": "The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
", "UpdateAccountCustomizationRequest$AwsAccountId": "The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
", "UpdateAccountCustomizationResponse$AwsAccountId": "The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
", "UpdateAccountSettingsRequest$AwsAccountId": "The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
", @@ -3827,6 +3855,26 @@ "refs": { } }, + "DescribeDashboardSnapshotJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeDashboardSnapshotJobResponse": { + "base": null, + "refs": { + } + }, + "DescribeDashboardSnapshotJobResultRequest": { + "base": null, + "refs": { + } + }, + "DescribeDashboardSnapshotJobResultResponse": { + "base": null, + "refs": { + } + }, "DescribeDataSetPermissionsRequest": { "base": null, "refs": { @@ -7019,13 +7067,19 @@ "DecimalParameter$Name": "A display name for the decimal parameter.
", "DescribeAssetBundleExportJobResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "DescribeAssetBundleImportJobResponse$RequestId": "The Amazon Web Services request ID for this operation.
", + "DescribeDashboardSnapshotJobResponse$RequestId": "The Amazon Web Services request ID for this operation.
", + "DescribeDashboardSnapshotJobResultResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "Entity$Path": "The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
", "IntegerParameter$Name": "The name of the integer parameter.
", "ListAssetBundleExportJobsResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "ListAssetBundleImportJobsResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "ReferenceLineCustomLabelConfiguration$CustomLabel": "The string text of the custom label.
", + "S3BucketConfiguration$BucketName": "The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
", + "S3BucketConfiguration$BucketPrefix": "The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
", + "S3BucketConfiguration$BucketRegion": "The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
The Amazon Web Services response ID for this operation.
", "StartAssetBundleImportJobResponse$RequestId": "The Amazon Web Services response ID for this operation.
", + "StartDashboardSnapshotJobResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "StringParameter$Name": "A display name for a string parameter.
", "TemplateError$Message": "Description of the error type.
", "ThemeError$Message": "The error message.
" @@ -7367,6 +7421,7 @@ "refs": { "CreateAnalysisRequest$Parameters": "The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
", "CreateDashboardRequest$Parameters": "The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
", + "SnapshotConfiguration$Parameters": null, "UpdateAnalysisRequest$Parameters": "The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
", "UpdateDashboardRequest$Parameters": "A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
" } @@ -8522,6 +8577,12 @@ "ManifestFileLocation$Bucket": "Amazon S3 bucket.
" } }, + "S3BucketConfiguration": { + "base": "An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.
", + "refs": { + "SnapshotS3DestinationConfiguration$BucketConfiguration": "A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
" + } + }, "S3Key": { "base": null, "refs": { @@ -8854,6 +8915,12 @@ "IntegerDefaultValueList$member": null } }, + "SensitiveS3Uri": { + "base": null, + "refs": { + "SnapshotJobS3Result$S3Uri": "The Amazon S3 Uri.
" + } + }, "SensitiveString": { "base": null, "refs": { @@ -8935,13 +9002,21 @@ "refs": { "RowLevelPermissionTagRule$TagKey": "The unique key for a tag.
", "RowLevelPermissionTagRuleConfiguration$member": null, - "SessionTag$Key": "The key for the tag.
" + "SessionTag$Key": "The key for the tag.
", + "SessionTagKeyList$member": null + } + }, + "SessionTagKeyList": { + "base": null, + "refs": { + "SnapshotAnonymousUserRedacted$RowLevelPermissionTagKeys": "The tag keys for the RowLevelPermissionTags.
The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
" + "GenerateEmbedUrlForAnonymousUserRequest$SessionTags": "The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
", + "SnapshotAnonymousUser$RowLevelPermissionTags": "The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.
These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
" } }, "SessionTagValue": { @@ -8988,6 +9063,24 @@ "FilterDateTimePickerControl$Type": "The date time picker type of a FilterDateTimePickerControl. Choose one of the following options:
SINGLE_VALUED: The filter condition is a fixed date.
DATE_RANGE: The filter condition is a date time range.
A control to display info icons for filters and parameters.
", + "refs": { + "DateTimePickerControlDisplayOptions$InfoIconLabelOptions": "The configuration of info icon label options.
", + "DropDownControlDisplayOptions$InfoIconLabelOptions": "The configuration of info icon label options.
", + "ListControlDisplayOptions$InfoIconLabelOptions": "The configuration of info icon label options.
", + "RelativeDateTimeControlDisplayOptions$InfoIconLabelOptions": "The configuration of info icon label options.
", + "SliderControlDisplayOptions$InfoIconLabelOptions": "The configuration of info icon label options.
", + "TextAreaControlDisplayOptions$InfoIconLabelOptions": "The configuration of info icon label options.
", + "TextFieldControlDisplayOptions$InfoIconLabelOptions": "The configuration of info icon label options.
" + } + }, + "SheetControlInfoIconText": { + "base": null, + "refs": { + "SheetControlInfoIconLabelOptions$InfoIconText": "The text content of info icon.
" + } + }, "SheetControlLayout": { "base": "A grid layout to define the placement of sheet control.
", "refs": { @@ -9215,6 +9308,12 @@ "DescribeDashboardPermissionsRequest$DashboardId": "The ID for the dashboard, also added to the IAM policy.
", "DescribeDashboardPermissionsResponse$DashboardId": "The ID for the dashboard.
", "DescribeDashboardRequest$DashboardId": "The ID for the dashboard.
", + "DescribeDashboardSnapshotJobRequest$DashboardId": "The ID of the dashboard that you have started a snapshot job for.
", + "DescribeDashboardSnapshotJobRequest$SnapshotJobId": "The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
The ID of the dashboard that you have started a snapshot job for.
", + "DescribeDashboardSnapshotJobResponse$SnapshotJobId": "The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
The ID of the dashboard that you have started a snapshot job for.
", + "DescribeDashboardSnapshotJobResultRequest$SnapshotJobId": "The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
The ID for the template.
", "DescribeTemplateDefinitionRequest$TemplateId": "The ID of the template that you're describing.
", "DescribeTemplateDefinitionResponse$TemplateId": "The ID of the template described.
", @@ -9288,10 +9387,15 @@ "SheetDefinition$SheetId": "The unique identifier of a sheet.
", "SheetTextBox$SheetTextBoxId": "The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.
", "SheetVisualScopingConfiguration$SheetId": "The selected sheet that the filter is applied to.
", + "SnapshotFileSheetSelection$SheetId": "The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV or PDF format types.
", + "SnapshotFileSheetSelectionVisualIdList$member": null, "StartAssetBundleExportJobRequest$AssetBundleExportJobId": "The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
", "StartAssetBundleExportJobResponse$AssetBundleExportJobId": "The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
", "StartAssetBundleImportJobRequest$AssetBundleImportJobId": "The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
", "StartAssetBundleImportJobResponse$AssetBundleImportJobId": "The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
", + "StartDashboardSnapshotJobRequest$DashboardId": "The ID of the dashboard that you want to start a snapshot job for.
", + "StartDashboardSnapshotJobRequest$SnapshotJobId": "An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
", "TargetVisualList$member": null, "Template$TemplateId": "The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
", @@ -9345,6 +9449,12 @@ "CreateAccountSubscriptionResponse$SignupResponse": "A SignupResponse object that returns information about a newly created Amazon QuickSight account.
The built-in aggregation functions for attributes.
UNIQUE_VALUE: Returns the unique value for a field, aggregated by the dimension fields.
The simple cluster marker of the cluster marker.
", "refs": { @@ -9406,6 +9516,178 @@ "PieChartConfiguration$SmallMultiplesOptions": "The small multiples setup for the visual.
" } }, + "SnapshotAnonymousUser": { + "base": "A structure that contains information on the anonymous user configuration.
", + "refs": { + "SnapshotAnonymousUserList$member": null + } + }, + "SnapshotAnonymousUserList": { + "base": null, + "refs": { + "SnapshotUserConfiguration$AnonymousUsers": "An array of records that describe the anonymous users that the dashboard snapshot is generated for.
" + } + }, + "SnapshotAnonymousUserRedacted": { + "base": "Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.
", + "refs": { + "SnapshotAnonymousUserRedactedList$member": null + } + }, + "SnapshotAnonymousUserRedactedList": { + "base": null, + "refs": { + "SnapshotUserConfigurationRedacted$AnonymousUsers": "An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.
" + } + }, + "SnapshotConfiguration": { + "base": "Describes the configuration of the dashboard snapshot.
", + "refs": { + "DescribeDashboardSnapshotJobResponse$SnapshotConfiguration": "The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.
A structure that describes the configuration of the dashboard snapshot.
" + } + }, + "SnapshotDestinationConfiguration": { + "base": "A structure that contains information on the Amazon S3 destinations of the generated snapshot.
", + "refs": { + "SnapshotConfiguration$DestinationConfiguration": "A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
" + } + }, + "SnapshotFile": { + "base": "A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.
", + "refs": { + "SnapshotFileList$member": null + } + }, + "SnapshotFileFormatType": { + "base": null, + "refs": { + "SnapshotFile$FormatType": "The format of the snapshot file to be generated. You can choose between CSV and PDF.
A structure that contains the information on the snapshot files.
", + "refs": { + "SnapshotFileGroupList$member": null + } + }, + "SnapshotFileGroupList": { + "base": null, + "refs": { + "SnapshotConfiguration$FileGroups": "A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.
A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.
A list of SnapshotFile objects.
A structure that contains information that identifies the snapshot that needs to be generated.
", + "refs": { + "SnapshotFileSheetSelectionList$member": null + } + }, + "SnapshotFileSheetSelectionList": { + "base": null, + "refs": { + "SnapshotFile$SheetSelections": "A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations or 1 configuration for PDF.
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV.
A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV. This value supports a maximum of 1 visual ID.
" + } + }, + "SnapshotJobErrorInfo": { + "base": "An object that contains information on the error that caused the snapshot job to fail.
", + "refs": { + "DescribeDashboardSnapshotJobResultResponse$ErrorInfo": "Displays information for the error that caused a job to fail.
" + } + }, + "SnapshotJobResult": { + "base": "An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.
", + "refs": { + "DescribeDashboardSnapshotJobResultResponse$Result": "The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
" + } + }, + "SnapshotJobResultErrorInfo": { + "base": "Information on the error that caused the snapshot job to fail.
", + "refs": { + "SnapshotJobResultErrorInfoList$member": null + } + }, + "SnapshotJobResultErrorInfoList": { + "base": null, + "refs": { + "SnapshotJobS3Result$ErrorInfo": "An array of error records that describe any failures that occur while the dashboard snapshot job runs.
" + } + }, + "SnapshotJobResultFileGroup": { + "base": "A structure that contains information on the generated snapshot file groups.
", + "refs": { + "SnapshotJobResultFileGroupList$member": null + } + }, + "SnapshotJobResultFileGroupList": { + "base": null, + "refs": { + "AnonymousUserSnapshotJobResult$FileGroups": "A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.
The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.
A list of SnapshotJobS3Result objects.
Indicates the status of a job. The status updates as the job executes. This shows one of the following values.
COMPLETED - The job was completed successfully.
FAILED - The job failed to execute.
QUEUED - The job is queued and hasn't started yet.
RUNNING - The job is still running.
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.
A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.
", + "refs": { + "SnapshotJobS3Result$S3DestinationConfiguration": "A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.
A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.
A structure that contains information about the users that the dashboard snapshot is generated for.
", + "refs": { + "StartDashboardSnapshotJobRequest$UserConfiguration": "A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.
" + } + }, + "SnapshotUserConfigurationRedacted": { + "base": "A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.
", + "refs": { + "DescribeDashboardSnapshotJobResponse$UserConfiguration": "The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.
The parameters for Snowflake.
", "refs": { @@ -9487,6 +9769,16 @@ "refs": { } }, + "StartDashboardSnapshotJobRequest": { + "base": null, + "refs": { + } + }, + "StartDashboardSnapshotJobResponse": { + "base": null, + "refs": { + } + }, "StatePersistenceConfigurations": { "base": "The state perssitence configuration of an embedded dashboard.
", "refs": { @@ -9560,6 +9852,8 @@ "DescribeDashboardDefinitionResponse$Status": "The HTTP status of the request.
", "DescribeDashboardPermissionsResponse$Status": "The HTTP status of the request.
", "DescribeDashboardResponse$Status": "The HTTP status of this request.
", + "DescribeDashboardSnapshotJobResponse$Status": "The HTTP status of the request
", + "DescribeDashboardSnapshotJobResultResponse$Status": "The HTTP status of the request
", "DescribeDataSetPermissionsResponse$Status": "The HTTP status of the request.
", "DescribeDataSetRefreshPropertiesResponse$Status": "The HTTP status of the request.
", "DescribeDataSetResponse$Status": "The HTTP status of the request.
", @@ -9631,6 +9925,7 @@ "SearchGroupsResponse$Status": "The HTTP status of the request.
", "StartAssetBundleExportJobResponse$Status": "The HTTP status of the response.
", "StartAssetBundleImportJobResponse$Status": "The HTTP status of the response.
", + "StartDashboardSnapshotJobResponse$Status": "The HTTP status of the request
", "TagResourceResponse$Status": "The HTTP status of the request.
", "UntagResourceResponse$Status": "The HTTP status of the request.
", "UpdateAccountCustomizationResponse$Status": "The HTTP status of the request.
", @@ -9680,6 +9975,7 @@ "AssetBundleImportJobRefreshScheduleOverrideParameters$ScheduleId": "A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
", "AssetBundleImportSourceDescription$Body": "An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.
The text for the axis label.
", "CancelIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
", "CancelIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
", @@ -9974,6 +10270,10 @@ "SignupResponse$userLoginName": "The user login name for your Amazon QuickSight account.
", "SignupResponse$accountName": "The name of your Amazon QuickSight account.
", "SignupResponse$directoryType": "The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD.
The error message.
", + "SnapshotJobErrorInfo$ErrorType": "The error type.
", + "SnapshotJobResultErrorInfo$ErrorMessage": "The error message.
", + "SnapshotJobResultErrorInfo$ErrorType": "The error type.
", "StringList$member": null, "SubtotalOptions$CustomLabel": "The custom label string for the subtotal cells.
", "TableFieldCustomTextContent$Value": "The string value of the custom text content for the table URL link content.
", @@ -10820,6 +11120,10 @@ "DeleteAnalysisResponse$DeletionTime": "The date and time that the analysis is scheduled to be deleted.
", "DescribeAssetBundleExportJobResponse$CreatedTime": "The time that the export job was created.
", "DescribeAssetBundleImportJobResponse$CreatedTime": "The time that the import job was created.
", + "DescribeDashboardSnapshotJobResponse$CreatedTime": "The time that the snapshot job was created.
", + "DescribeDashboardSnapshotJobResponse$LastUpdatedTime": "The time that the snapshot job status was last updated.
", + "DescribeDashboardSnapshotJobResultResponse$CreatedTime": "The time that a snapshot job was created.
", + "DescribeDashboardSnapshotJobResultResponse$LastUpdatedTime": "The time that a snapshot job status was last updated.
", "Folder$CreatedTime": "The time that the folder was created.
", "Folder$LastUpdatedTime": "The time that the folder was last updated.
", "FolderSummary$CreatedTime": "The time that the folder was created.
", @@ -11843,6 +12147,7 @@ "RangeEndsLabelType$Visibility": "The visibility of the range ends label.
", "ScrollBarOptions$Visibility": "The visibility of the data zoom scroll bar.
", "SecondaryValueOptions$Visibility": "Determines the visibility of the secondary value.
", + "SheetControlInfoIconLabelOptions$Visibility": "The visibility configuration of info icon label options.
", "SheetElementConfigurationOverrides$Visibility": "Determines whether or not the overrides are visible. Choose one of the following options:
VISIBLE
HIDDEN
The visibility configuration for the subtotal cells.
", "TableCellStyle$Visibility": "The visibility of the table cells.
", diff --git a/models/apis/quicksight/2018-04-01/paginators-1.json b/models/apis/quicksight/2018-04-01/paginators-1.json index 18fac260cad..e5ce3441c3c 100644 --- a/models/apis/quicksight/2018-04-01/paginators-1.json +++ b/models/apis/quicksight/2018-04-01/paginators-1.json @@ -42,6 +42,30 @@ "limit_key": "MaxResults", "result_key": "DataSources" }, + "ListGroupMemberships": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "GroupMemberList" + }, + "ListGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "GroupList" + }, + "ListIAMPolicyAssignments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "IAMPolicyAssignments" + }, + "ListIAMPolicyAssignmentsForUser": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ActiveAssignments" + }, "ListIngestions": { "input_token": "NextToken", "output_token": "NextToken", @@ -89,6 +113,18 @@ "output_token": "NextToken", "limit_key": "MaxResults" }, + "ListUserGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "GroupList" + }, + "ListUsers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "UserList" + }, "ListVPCConnections": { "input_token": "NextToken", "output_token": "NextToken", @@ -117,6 +153,12 @@ "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "DataSourceSummaries" + }, + "SearchGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "GroupList" } } } diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index a5cf935e9d5..33033479758 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -1461,16 +1461,20 @@ "ap-northeast-2" : { }, "ap-northeast-3" : { }, "ap-south-1" : { }, + "ap-south-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-central-2" : { }, "eu-north-1" : { }, "eu-south-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "me-central-1" : { }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, diff --git a/service/chimesdkmediapipelines/api.go b/service/chimesdkmediapipelines/api.go index 805f1b53630..457ae4d96ce 100644 --- a/service/chimesdkmediapipelines/api.go +++ b/service/chimesdkmediapipelines/api.go @@ -2053,6 +2053,38 @@ func (c *ChimeSDKMediaPipelines) UpdateMediaInsightsPipelineStatusWithContext(ct return out, req.Send() } +// Defines the configuration for an ActiveSpeakerOnly video tile. +type ActiveSpeakerOnlyConfiguration struct { + _ struct{} `type:"structure"` + + // The position of the ActiveSpeakerOnly video tile. + ActiveSpeakerPosition *string `type:"string" enum:"ActiveSpeakerPosition"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ActiveSpeakerOnlyConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ActiveSpeakerOnlyConfiguration) GoString() string { + return s.String() +} + +// SetActiveSpeakerPosition sets the ActiveSpeakerPosition field's value. +func (s *ActiveSpeakerOnlyConfiguration) SetActiveSpeakerPosition(v string) *ActiveSpeakerOnlyConfiguration { + s.ActiveSpeakerPosition = &v + return s +} + // A structure that contains the configuration settings for an Amazon Transcribe // call analytics processor. type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { @@ -2352,6 +2384,9 @@ type AmazonTranscribeProcessorConfiguration struct { // target. FilterPartialResults *bool `type:"boolean"` + // Turns language identification on or off. + IdentifyLanguage *bool `type:"boolean"` + // The language code that represents the language spoken in your audio. // // If you're unsure of the language spoken in your audio, consider using IdentifyLanguage @@ -2360,9 +2395,7 @@ type AmazonTranscribeProcessorConfiguration struct { // For a list of languages that real-time Call Analytics supports, see the Supported // languages table (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // in the Amazon Transcribe Developer Guide. - // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"CallAnalyticsLanguageCode"` + LanguageCode *string `type:"string" enum:"CallAnalyticsLanguageCode"` // The name of the custom language model that you want to use when processing // your transcription. Note that language model names are case sensitive. @@ -2376,6 +2409,9 @@ type AmazonTranscribeProcessorConfiguration struct { // in the Amazon Transcribe Developer Guide. LanguageModelName *string `min:"1" type:"string"` + // The language options for the transcription, such as automatic language detection. + LanguageOptions *string `min:"1" type:"string"` + // The level of stability to use when you enable partial results stabilization // (EnablePartialResultsStabilization). // @@ -2401,6 +2437,9 @@ type AmazonTranscribeProcessorConfiguration struct { // ALL. PiiEntityTypes *string `min:"1" type:"string"` + // The preferred language for the transcription. + PreferredLanguage *string `type:"string" enum:"CallAnalyticsLanguageCode"` + // Enables speaker partitioning (diarization) in your transcription output. // Speaker partitioning labels the speech from individual speakers in your media // file. @@ -2418,11 +2457,17 @@ type AmazonTranscribeProcessorConfiguration struct { // Length Constraints: Minimum length of 1. Maximum length of 200. VocabularyFilterName *string `min:"1" type:"string"` + // The names of the custom vocabulary filter or filters using during transcription. + VocabularyFilterNames *string `min:"1" type:"string"` + // The name of the custom vocabulary that you specified in your Call Analytics // request. // // Length Constraints: Minimum length of 1. Maximum length of 200. VocabularyName *string `min:"1" type:"string"` + + // The names of the custom vocabulary or vocabularies used during transcription. + VocabularyNames *string `min:"1" type:"string"` } // String returns the string representation. @@ -2446,21 +2491,27 @@ func (s AmazonTranscribeProcessorConfiguration) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *AmazonTranscribeProcessorConfiguration) Validate() error { invalidParams := request.ErrInvalidParams{Context: "AmazonTranscribeProcessorConfiguration"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } if s.LanguageModelName != nil && len(*s.LanguageModelName) < 1 { invalidParams.Add(request.NewErrParamMinLen("LanguageModelName", 1)) } + if s.LanguageOptions != nil && len(*s.LanguageOptions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LanguageOptions", 1)) + } if s.PiiEntityTypes != nil && len(*s.PiiEntityTypes) < 1 { invalidParams.Add(request.NewErrParamMinLen("PiiEntityTypes", 1)) } if s.VocabularyFilterName != nil && len(*s.VocabularyFilterName) < 1 { invalidParams.Add(request.NewErrParamMinLen("VocabularyFilterName", 1)) } + if s.VocabularyFilterNames != nil && len(*s.VocabularyFilterNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VocabularyFilterNames", 1)) + } if s.VocabularyName != nil && len(*s.VocabularyName) < 1 { invalidParams.Add(request.NewErrParamMinLen("VocabularyName", 1)) } + if s.VocabularyNames != nil && len(*s.VocabularyNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VocabularyNames", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -2492,6 +2543,12 @@ func (s *AmazonTranscribeProcessorConfiguration) SetFilterPartialResults(v bool) return s } +// SetIdentifyLanguage sets the IdentifyLanguage field's value. +func (s *AmazonTranscribeProcessorConfiguration) SetIdentifyLanguage(v bool) *AmazonTranscribeProcessorConfiguration { + s.IdentifyLanguage = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *AmazonTranscribeProcessorConfiguration) SetLanguageCode(v string) *AmazonTranscribeProcessorConfiguration { s.LanguageCode = &v @@ -2504,6 +2561,12 @@ func (s *AmazonTranscribeProcessorConfiguration) SetLanguageModelName(v string) return s } +// SetLanguageOptions sets the LanguageOptions field's value. +func (s *AmazonTranscribeProcessorConfiguration) SetLanguageOptions(v string) *AmazonTranscribeProcessorConfiguration { + s.LanguageOptions = &v + return s +} + // SetPartialResultsStability sets the PartialResultsStability field's value. func (s *AmazonTranscribeProcessorConfiguration) SetPartialResultsStability(v string) *AmazonTranscribeProcessorConfiguration { s.PartialResultsStability = &v @@ -2516,6 +2579,12 @@ func (s *AmazonTranscribeProcessorConfiguration) SetPiiEntityTypes(v string) *Am return s } +// SetPreferredLanguage sets the PreferredLanguage field's value. +func (s *AmazonTranscribeProcessorConfiguration) SetPreferredLanguage(v string) *AmazonTranscribeProcessorConfiguration { + s.PreferredLanguage = &v + return s +} + // SetShowSpeakerLabel sets the ShowSpeakerLabel field's value. func (s *AmazonTranscribeProcessorConfiguration) SetShowSpeakerLabel(v bool) *AmazonTranscribeProcessorConfiguration { s.ShowSpeakerLabel = &v @@ -2534,12 +2603,24 @@ func (s *AmazonTranscribeProcessorConfiguration) SetVocabularyFilterName(v strin return s } +// SetVocabularyFilterNames sets the VocabularyFilterNames field's value. +func (s *AmazonTranscribeProcessorConfiguration) SetVocabularyFilterNames(v string) *AmazonTranscribeProcessorConfiguration { + s.VocabularyFilterNames = &v + return s +} + // SetVocabularyName sets the VocabularyName field's value. func (s *AmazonTranscribeProcessorConfiguration) SetVocabularyName(v string) *AmazonTranscribeProcessorConfiguration { s.VocabularyName = &v return s } +// SetVocabularyNames sets the VocabularyNames field's value. +func (s *AmazonTranscribeProcessorConfiguration) SetVocabularyNames(v string) *AmazonTranscribeProcessorConfiguration { + s.VocabularyNames = &v + return s +} + // The configuration for the artifacts concatenation. type ArtifactsConcatenationConfiguration struct { _ struct{} `type:"structure"` @@ -4225,7 +4306,8 @@ type CreateMediaInsightsPipelineInput struct { // String and GoString methods. MediaInsightsRuntimeMetadata map[string]*string `type:"map" sensitive:"true"` - // The runtime configuration for the S3 recording sink. + // The runtime configuration for the S3 recording sink. If specified, the settings + // in this structure override any settings in S3RecordingSinkConfiguration. S3RecordingSinkRuntimeConfiguration *S3RecordingSinkRuntimeConfiguration `type:"structure"` // The tags assigned to the media insights pipeline. @@ -5185,13 +5267,28 @@ func (s *GetMediaPipelineOutput) SetMediaPipeline(v *MediaPipeline) *GetMediaPip type GridViewConfiguration struct { _ struct{} `type:"structure"` + // The configuration settings for an ActiveSpeakerOnly video tile. + ActiveSpeakerOnlyConfiguration *ActiveSpeakerOnlyConfiguration `type:"structure"` + + // The orientation setting, horizontal or vertical. + CanvasOrientation *string `type:"string" enum:"CanvasOrientation"` + // Defines the layout of the video tiles when content sharing is enabled. // // ContentShareLayout is a required field ContentShareLayout *string `type:"string" required:"true" enum:"ContentShareLayoutOption"` + // The configuration settings for a horizontal layout. + HorizontalLayoutConfiguration *HorizontalLayoutConfiguration `type:"structure"` + // Defines the configuration options for a presenter only video tile. PresenterOnlyConfiguration *PresenterOnlyConfiguration `type:"structure"` + + // The configuration settings for a vertical layout. + VerticalLayoutConfiguration *VerticalLayoutConfiguration `type:"structure"` + + // The attribute settings for the video tiles. + VideoAttribute *VideoAttribute `type:"structure"` } // String returns the string representation. @@ -5218,6 +5315,21 @@ func (s *GridViewConfiguration) Validate() error { if s.ContentShareLayout == nil { invalidParams.Add(request.NewErrParamRequired("ContentShareLayout")) } + if s.HorizontalLayoutConfiguration != nil { + if err := s.HorizontalLayoutConfiguration.Validate(); err != nil { + invalidParams.AddNested("HorizontalLayoutConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.VerticalLayoutConfiguration != nil { + if err := s.VerticalLayoutConfiguration.Validate(); err != nil { + invalidParams.AddNested("VerticalLayoutConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.VideoAttribute != nil { + if err := s.VideoAttribute.Validate(); err != nil { + invalidParams.AddNested("VideoAttribute", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -5225,18 +5337,120 @@ func (s *GridViewConfiguration) Validate() error { return nil } +// SetActiveSpeakerOnlyConfiguration sets the ActiveSpeakerOnlyConfiguration field's value. +func (s *GridViewConfiguration) SetActiveSpeakerOnlyConfiguration(v *ActiveSpeakerOnlyConfiguration) *GridViewConfiguration { + s.ActiveSpeakerOnlyConfiguration = v + return s +} + +// SetCanvasOrientation sets the CanvasOrientation field's value. +func (s *GridViewConfiguration) SetCanvasOrientation(v string) *GridViewConfiguration { + s.CanvasOrientation = &v + return s +} + // SetContentShareLayout sets the ContentShareLayout field's value. func (s *GridViewConfiguration) SetContentShareLayout(v string) *GridViewConfiguration { s.ContentShareLayout = &v return s } +// SetHorizontalLayoutConfiguration sets the HorizontalLayoutConfiguration field's value. +func (s *GridViewConfiguration) SetHorizontalLayoutConfiguration(v *HorizontalLayoutConfiguration) *GridViewConfiguration { + s.HorizontalLayoutConfiguration = v + return s +} + // SetPresenterOnlyConfiguration sets the PresenterOnlyConfiguration field's value. func (s *GridViewConfiguration) SetPresenterOnlyConfiguration(v *PresenterOnlyConfiguration) *GridViewConfiguration { s.PresenterOnlyConfiguration = v return s } +// SetVerticalLayoutConfiguration sets the VerticalLayoutConfiguration field's value. +func (s *GridViewConfiguration) SetVerticalLayoutConfiguration(v *VerticalLayoutConfiguration) *GridViewConfiguration { + s.VerticalLayoutConfiguration = v + return s +} + +// SetVideoAttribute sets the VideoAttribute field's value. +func (s *GridViewConfiguration) SetVideoAttribute(v *VideoAttribute) *GridViewConfiguration { + s.VideoAttribute = v + return s +} + +// Defines the configuration settings for the horizontal layout. +type HorizontalLayoutConfiguration struct { + _ struct{} `type:"structure"` + + // Sets the aspect ratio of the video tiles, such as 16:9. + TileAspectRatio *string `type:"string"` + + // The maximum number of video tiles to display. + TileCount *int64 `min:"1" type:"integer"` + + // Sets the automatic ordering of the video tiles. + TileOrder *string `type:"string" enum:"TileOrder"` + + // Sets the position of horizontal tiles. + TilePosition *string `type:"string" enum:"HorizontalTilePosition"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HorizontalLayoutConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HorizontalLayoutConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *HorizontalLayoutConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "HorizontalLayoutConfiguration"} + if s.TileCount != nil && *s.TileCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("TileCount", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTileAspectRatio sets the TileAspectRatio field's value. +func (s *HorizontalLayoutConfiguration) SetTileAspectRatio(v string) *HorizontalLayoutConfiguration { + s.TileAspectRatio = &v + return s +} + +// SetTileCount sets the TileCount field's value. +func (s *HorizontalLayoutConfiguration) SetTileCount(v int64) *HorizontalLayoutConfiguration { + s.TileCount = &v + return s +} + +// SetTileOrder sets the TileOrder field's value. +func (s *HorizontalLayoutConfiguration) SetTileOrder(v string) *HorizontalLayoutConfiguration { + s.TileOrder = &v + return s +} + +// SetTilePosition sets the TilePosition field's value. +func (s *HorizontalLayoutConfiguration) SetTilePosition(v string) *HorizontalLayoutConfiguration { + s.TilePosition = &v + return s +} + // A structure that contains the configuration settings for an issue detection // task. type IssueDetectionConfiguration struct { @@ -9156,6 +9370,78 @@ func (s UpdateMediaInsightsPipelineStatusOutput) GoString() string { return s.String() } +// Defines the configuration settings for a vertial layout. +type VerticalLayoutConfiguration struct { + _ struct{} `type:"structure"` + + // Sets the aspect ratio of the video tiles, such as 16:9. + TileAspectRatio *string `type:"string"` + + // The maximum number of tiles to display. + TileCount *int64 `min:"1" type:"integer"` + + // Sets the automatic ordering of the video tiles. + TileOrder *string `type:"string" enum:"TileOrder"` + + // Sets the position of vertical tiles. + TilePosition *string `type:"string" enum:"VerticalTilePosition"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VerticalLayoutConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VerticalLayoutConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *VerticalLayoutConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "VerticalLayoutConfiguration"} + if s.TileCount != nil && *s.TileCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("TileCount", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTileAspectRatio sets the TileAspectRatio field's value. +func (s *VerticalLayoutConfiguration) SetTileAspectRatio(v string) *VerticalLayoutConfiguration { + s.TileAspectRatio = &v + return s +} + +// SetTileCount sets the TileCount field's value. +func (s *VerticalLayoutConfiguration) SetTileCount(v int64) *VerticalLayoutConfiguration { + s.TileCount = &v + return s +} + +// SetTileOrder sets the TileOrder field's value. +func (s *VerticalLayoutConfiguration) SetTileOrder(v string) *VerticalLayoutConfiguration { + s.TileOrder = &v + return s +} + +// SetTilePosition sets the TilePosition field's value. +func (s *VerticalLayoutConfiguration) SetTilePosition(v string) *VerticalLayoutConfiguration { + s.TilePosition = &v + return s +} + // The video artifact configuration object. type VideoArtifactsConfiguration struct { _ struct{} `type:"structure"` @@ -9212,6 +9498,81 @@ func (s *VideoArtifactsConfiguration) SetState(v string) *VideoArtifactsConfigur return s } +// Defines the settings for a video tile. +type VideoAttribute struct { + _ struct{} `type:"structure"` + + // Defines the border color of all video tiles. + BorderColor *string `type:"string" enum:"BorderColor"` + + // Defines the border thickness for all video tiles. + BorderThickness *int64 `min:"1" type:"integer"` + + // Sets the corner radius of all video tiles. + CornerRadius *int64 `min:"1" type:"integer"` + + // Defines the highlight color for the active video tile. + HighlightColor *string `type:"string" enum:"HighlightColor"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VideoAttribute) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VideoAttribute) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *VideoAttribute) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "VideoAttribute"} + if s.BorderThickness != nil && *s.BorderThickness < 1 { + invalidParams.Add(request.NewErrParamMinValue("BorderThickness", 1)) + } + if s.CornerRadius != nil && *s.CornerRadius < 1 { + invalidParams.Add(request.NewErrParamMinValue("CornerRadius", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBorderColor sets the BorderColor field's value. +func (s *VideoAttribute) SetBorderColor(v string) *VideoAttribute { + s.BorderColor = &v + return s +} + +// SetBorderThickness sets the BorderThickness field's value. +func (s *VideoAttribute) SetBorderThickness(v int64) *VideoAttribute { + s.BorderThickness = &v + return s +} + +// SetCornerRadius sets the CornerRadius field's value. +func (s *VideoAttribute) SetCornerRadius(v int64) *VideoAttribute { + s.CornerRadius = &v + return s +} + +// SetHighlightColor sets the HighlightColor field's value. +func (s *VideoAttribute) SetHighlightColor(v string) *VideoAttribute { + s.HighlightColor = &v + return s +} + // The configuration object of a video concatenation pipeline. type VideoConcatenationConfiguration struct { _ struct{} `type:"structure"` @@ -9300,6 +9661,30 @@ func (s *VoiceAnalyticsProcessorConfiguration) SetVoiceToneAnalysisStatus(v stri return s } +const ( + // ActiveSpeakerPositionTopLeft is a ActiveSpeakerPosition enum value + ActiveSpeakerPositionTopLeft = "TopLeft" + + // ActiveSpeakerPositionTopRight is a ActiveSpeakerPosition enum value + ActiveSpeakerPositionTopRight = "TopRight" + + // ActiveSpeakerPositionBottomLeft is a ActiveSpeakerPosition enum value + ActiveSpeakerPositionBottomLeft = "BottomLeft" + + // ActiveSpeakerPositionBottomRight is a ActiveSpeakerPosition enum value + ActiveSpeakerPositionBottomRight = "BottomRight" +) + +// ActiveSpeakerPosition_Values returns all elements of the ActiveSpeakerPosition enum +func ActiveSpeakerPosition_Values() []string { + return []string{ + ActiveSpeakerPositionTopLeft, + ActiveSpeakerPositionTopRight, + ActiveSpeakerPositionBottomLeft, + ActiveSpeakerPositionBottomRight, + } +} + const ( // ArtifactsConcatenationStateEnabled is a ArtifactsConcatenationState enum value ArtifactsConcatenationStateEnabled = "Enabled" @@ -9380,6 +9765,38 @@ func AudioMuxType_Values() []string { } } +const ( + // BorderColorBlack is a BorderColor enum value + BorderColorBlack = "Black" + + // BorderColorBlue is a BorderColor enum value + BorderColorBlue = "Blue" + + // BorderColorRed is a BorderColor enum value + BorderColorRed = "Red" + + // BorderColorGreen is a BorderColor enum value + BorderColorGreen = "Green" + + // BorderColorWhite is a BorderColor enum value + BorderColorWhite = "White" + + // BorderColorYellow is a BorderColor enum value + BorderColorYellow = "Yellow" +) + +// BorderColor_Values returns all elements of the BorderColor enum +func BorderColor_Values() []string { + return []string{ + BorderColorBlack, + BorderColorBlue, + BorderColorRed, + BorderColorGreen, + BorderColorWhite, + BorderColorYellow, + } +} + const ( // CallAnalyticsLanguageCodeEnUs is a CallAnalyticsLanguageCode enum value CallAnalyticsLanguageCodeEnUs = "en-US" @@ -9424,6 +9841,22 @@ func CallAnalyticsLanguageCode_Values() []string { } } +const ( + // CanvasOrientationLandscape is a CanvasOrientation enum value + CanvasOrientationLandscape = "Landscape" + + // CanvasOrientationPortrait is a CanvasOrientation enum value + CanvasOrientationPortrait = "Portrait" +) + +// CanvasOrientation_Values returns all elements of the CanvasOrientation enum +func CanvasOrientation_Values() []string { + return []string{ + CanvasOrientationLandscape, + CanvasOrientationPortrait, + } +} + const ( // ConcatenationSinkTypeS3bucket is a ConcatenationSinkType enum value ConcatenationSinkTypeS3bucket = "S3Bucket" @@ -9485,6 +9918,9 @@ const ( // ContentShareLayoutOptionVertical is a ContentShareLayoutOption enum value ContentShareLayoutOptionVertical = "Vertical" + + // ContentShareLayoutOptionActiveSpeakerOnly is a ContentShareLayoutOption enum value + ContentShareLayoutOptionActiveSpeakerOnly = "ActiveSpeakerOnly" ) // ContentShareLayoutOption_Values returns all elements of the ContentShareLayoutOption enum @@ -9493,6 +9929,7 @@ func ContentShareLayoutOption_Values() []string { ContentShareLayoutOptionPresenterOnly, ContentShareLayoutOptionHorizontal, ContentShareLayoutOptionVertical, + ContentShareLayoutOptionActiveSpeakerOnly, } } @@ -9560,6 +9997,54 @@ func FragmentSelectorType_Values() []string { } } +const ( + // HighlightColorBlack is a HighlightColor enum value + HighlightColorBlack = "Black" + + // HighlightColorBlue is a HighlightColor enum value + HighlightColorBlue = "Blue" + + // HighlightColorRed is a HighlightColor enum value + HighlightColorRed = "Red" + + // HighlightColorGreen is a HighlightColor enum value + HighlightColorGreen = "Green" + + // HighlightColorWhite is a HighlightColor enum value + HighlightColorWhite = "White" + + // HighlightColorYellow is a HighlightColor enum value + HighlightColorYellow = "Yellow" +) + +// HighlightColor_Values returns all elements of the HighlightColor enum +func HighlightColor_Values() []string { + return []string{ + HighlightColorBlack, + HighlightColorBlue, + HighlightColorRed, + HighlightColorGreen, + HighlightColorWhite, + HighlightColorYellow, + } +} + +const ( + // HorizontalTilePositionTop is a HorizontalTilePosition enum value + HorizontalTilePositionTop = "Top" + + // HorizontalTilePositionBottom is a HorizontalTilePosition enum value + HorizontalTilePositionBottom = "Bottom" +) + +// HorizontalTilePosition_Values returns all elements of the HorizontalTilePosition enum +func HorizontalTilePosition_Values() []string { + return []string{ + HorizontalTilePositionTop, + HorizontalTilePositionBottom, + } +} + const ( // LayoutOptionGridView is a LayoutOption enum value LayoutOptionGridView = "GridView" @@ -9860,6 +10345,38 @@ func SentimentType_Values() []string { } } +const ( + // TileOrderJoinSequence is a TileOrder enum value + TileOrderJoinSequence = "JoinSequence" + + // TileOrderSpeakerSequence is a TileOrder enum value + TileOrderSpeakerSequence = "SpeakerSequence" +) + +// TileOrder_Values returns all elements of the TileOrder enum +func TileOrder_Values() []string { + return []string{ + TileOrderJoinSequence, + TileOrderSpeakerSequence, + } +} + +const ( + // VerticalTilePositionLeft is a VerticalTilePosition enum value + VerticalTilePositionLeft = "Left" + + // VerticalTilePositionRight is a VerticalTilePosition enum value + VerticalTilePositionRight = "Right" +) + +// VerticalTilePosition_Values returns all elements of the VerticalTilePosition enum +func VerticalTilePosition_Values() []string { + return []string{ + VerticalTilePositionLeft, + VerticalTilePositionRight, + } +} + const ( // VideoMuxTypeVideoOnly is a VideoMuxType enum value VideoMuxTypeVideoOnly = "VideoOnly" diff --git a/service/cloudformation/api.go b/service/cloudformation/api.go index bee8d9c1fc0..c5931d7549a 100644 --- a/service/cloudformation/api.go +++ b/service/cloudformation/api.go @@ -4262,6 +4262,95 @@ func (c *CloudFormation) ListImportsPagesWithContext(ctx aws.Context, input *Lis return p.Err() } +const opListStackInstanceResourceDrifts = "ListStackInstanceResourceDrifts" + +// ListStackInstanceResourceDriftsRequest generates a "aws/request.Request" representing the +// client's request for the ListStackInstanceResourceDrifts operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListStackInstanceResourceDrifts for more information on using the ListStackInstanceResourceDrifts +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListStackInstanceResourceDriftsRequest method. +// req, resp := client.ListStackInstanceResourceDriftsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstanceResourceDrifts +func (c *CloudFormation) ListStackInstanceResourceDriftsRequest(input *ListStackInstanceResourceDriftsInput) (req *request.Request, output *ListStackInstanceResourceDriftsOutput) { + op := &request.Operation{ + Name: opListStackInstanceResourceDrifts, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ListStackInstanceResourceDriftsInput{} + } + + output = &ListStackInstanceResourceDriftsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListStackInstanceResourceDrifts API operation for AWS CloudFormation. +// +// Returns drift information for resources in a stack instance. +// +// ListStackInstanceResourceDrifts returns drift information for the most recent +// drift detection operation. If an operation is in progress, it may only return +// partial results. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS CloudFormation's +// API operation ListStackInstanceResourceDrifts for usage and error information. +// +// Returned Error Codes: +// +// - ErrCodeStackSetNotFoundException "StackSetNotFoundException" +// The specified stack set doesn't exist. +// +// - ErrCodeStackInstanceNotFoundException "StackInstanceNotFoundException" +// The specified stack instance doesn't exist. +// +// - ErrCodeOperationNotFoundException "OperationNotFoundException" +// The specified ID refers to an operation that doesn't exist. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstanceResourceDrifts +func (c *CloudFormation) ListStackInstanceResourceDrifts(input *ListStackInstanceResourceDriftsInput) (*ListStackInstanceResourceDriftsOutput, error) { + req, out := c.ListStackInstanceResourceDriftsRequest(input) + return out, req.Send() +} + +// ListStackInstanceResourceDriftsWithContext is the same as ListStackInstanceResourceDrifts with the addition of +// the ability to pass a context and additional request options. +// +// See ListStackInstanceResourceDrifts for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CloudFormation) ListStackInstanceResourceDriftsWithContext(ctx aws.Context, input *ListStackInstanceResourceDriftsInput, opts ...request.Option) (*ListStackInstanceResourceDriftsOutput, error) { + req, out := c.ListStackInstanceResourceDriftsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListStackInstances = "ListStackInstances" // ListStackInstancesRequest generates a "aws/request.Request" representing the @@ -8192,7 +8281,7 @@ type CreateChangeSetInput struct { // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM resources in CloudFormation - // templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). + // templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform // custom processing on templates; this can include simple actions like find-and-replace @@ -8202,8 +8291,8 @@ type CreateChangeSetInput struct { // before actually creating the stack. If your stack template contains one // or more macros, and you choose to create a stack directly from the processed // template, without first reviewing the resulting changes in a change set, - // you must acknowledge this capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // you must acknowledge this capability. This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by CloudFormation. This capacity doesn't // apply to creating change sets, and specifying it when creating change // sets has no effect. If you want to create a stack from a stack template @@ -8211,7 +8300,7 @@ type CreateChangeSetInput struct { // stack directly from the template using the CreateStack or UpdateStack // action, and specifying this capability. For more information about macros, // see Using CloudFormation macros to perform custom processing on templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []*string `type:"list" enum:"Capability"` // The name of the change set. The name must be unique among all change sets @@ -8604,7 +8693,7 @@ type CreateStackInput struct { // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in CloudFormation - // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). + // Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform // custom processing on templates; this can include simple actions like find-and-replace @@ -8614,8 +8703,8 @@ type CreateStackInput struct { // before actually creating the stack. If your stack template contains one // or more macros, and you choose to create a stack directly from the processed // template, without first reviewing the resulting changes in a change set, - // you must acknowledge this capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // you must acknowledge this capability. This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by CloudFormation. If you want to // create a stack from a stack template that contains macros and nested stacks, // you must create the stack directly from the template using this capability. @@ -8624,7 +8713,7 @@ type CreateStackInput struct { // on an underlying Lambda service function for processing stack templates. // Be aware that the Lambda function owner can update the function operation // without CloudFormation being notified. For more information, see Using - // CloudFormation macros to perform custom processing on templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // CloudFormation macros to perform custom processing on templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []*string `type:"list" enum:"Capability"` // A unique identifier for this CreateStack request. Specify this token if you @@ -8653,11 +8742,11 @@ type CreateStackInput struct { // Whether to enable termination protection on the specified stack. If a user // attempts to delete a stack with termination protection enabled, the operation // fails and the stack remains unchanged. For more information, see Protecting - // a Stack From Being Deleted (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) + // a Stack From Being Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) // in the CloudFormation User Guide. Termination protection is deactivated on // stacks by default. // - // For nested stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), + // For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), // termination protection is set on the root stack and can't be changed directly // on the nested stack. EnableTerminationProtection *bool `type:"boolean"` @@ -9187,7 +9276,7 @@ type CreateStackSetInput struct { // Specify an IAM role only if you are using customized administrator roles // to control which users or groups can manage specific stack sets within the // same administrator account. For more information, see Prerequisites: Granting - // Permissions for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` @@ -9240,17 +9329,17 @@ type CreateStackSetInput struct { // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in CloudFormation - // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). + // Templates (https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack // set template references one or more macros, you must create the stack // set directly from the processed template, without first reviewing the // resulting changes in a change set. To create the stack set directly, you // must acknowledge this capability. For more information, see Using CloudFormation - // Macros to Perform Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html). // Stack sets with service-managed permissions don't currently support the - // use of macros in templates. (This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html) // transforms, which are macros hosted by CloudFormation.) Even if you specify // this capability for a stack set with service-managed permissions, if you // reference a macro in your template the stack set operation will fail. @@ -14376,6 +14465,220 @@ func (s *ListImportsOutput) SetNextToken(v string) *ListImportsOutput { return s } +type ListStackInstanceResourceDriftsInput struct { + _ struct{} `type:"structure"` + + // [Service-managed permissions] Specifies whether you are acting as an account + // administrator in the organization's management account or as a delegated + // administrator in a member account. + // + // By default, SELF is specified. Use SELF for stack sets with self-managed + // permissions. + // + // * If you are signed in to the management account, specify SELF. + // + // * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. + // Your Amazon Web Services account must be registered as a delegated administrator + // in the management account. For more information, see Register a delegated + // administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. + CallAs *string `type:"string" enum:"CallAs"` + + // The maximum number of results to be returned with a single call. If the number + // of available results exceeds this maximum, the response includes a NextToken + // value that you can assign to the NextToken request parameter to get the next + // set of results. + MaxResults *int64 `min:"1" type:"integer"` + + // If the previous paginated request didn't return all of the remaining results, + // the response object's NextToken parameter value is set to a token. To retrieve + // the next set of results, call this action again and assign that token to + // the request object's NextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `min:"1" type:"string"` + + // The unique ID of the drift operation. + // + // OperationId is a required field + OperationId *string `min:"1" type:"string" required:"true"` + + // The name of the Amazon Web Services account that you want to list resource + // drifts for. + // + // StackInstanceAccount is a required field + StackInstanceAccount *string `type:"string" required:"true"` + + // The name of the Region where you want to list resource drifts. + // + // StackInstanceRegion is a required field + StackInstanceRegion *string `type:"string" required:"true"` + + // The resource drift status of the stack instance. + // + // * DELETED: The resource differs from its expected template configuration + // in that the resource has been deleted. + // + // * MODIFIED: One or more resource properties differ from their expected + // template values. + // + // * IN_SYNC: The resource's actual configuration matches its expected template + // configuration. + // + // * NOT_CHECKED: CloudFormation doesn't currently return this value. + StackInstanceResourceDriftStatuses []*string `min:"1" type:"list" enum:"StackResourceDriftStatus"` + + // The name or unique ID of the stack set that you want to list drifted resources + // for. + // + // StackSetName is a required field + StackSetName *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStackInstanceResourceDriftsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStackInstanceResourceDriftsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListStackInstanceResourceDriftsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListStackInstanceResourceDriftsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.OperationId == nil { + invalidParams.Add(request.NewErrParamRequired("OperationId")) + } + if s.OperationId != nil && len(*s.OperationId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OperationId", 1)) + } + if s.StackInstanceAccount == nil { + invalidParams.Add(request.NewErrParamRequired("StackInstanceAccount")) + } + if s.StackInstanceRegion == nil { + invalidParams.Add(request.NewErrParamRequired("StackInstanceRegion")) + } + if s.StackInstanceResourceDriftStatuses != nil && len(s.StackInstanceResourceDriftStatuses) < 1 { + invalidParams.Add(request.NewErrParamMinLen("StackInstanceResourceDriftStatuses", 1)) + } + if s.StackSetName == nil { + invalidParams.Add(request.NewErrParamRequired("StackSetName")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCallAs sets the CallAs field's value. +func (s *ListStackInstanceResourceDriftsInput) SetCallAs(v string) *ListStackInstanceResourceDriftsInput { + s.CallAs = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListStackInstanceResourceDriftsInput) SetMaxResults(v int64) *ListStackInstanceResourceDriftsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStackInstanceResourceDriftsInput) SetNextToken(v string) *ListStackInstanceResourceDriftsInput { + s.NextToken = &v + return s +} + +// SetOperationId sets the OperationId field's value. +func (s *ListStackInstanceResourceDriftsInput) SetOperationId(v string) *ListStackInstanceResourceDriftsInput { + s.OperationId = &v + return s +} + +// SetStackInstanceAccount sets the StackInstanceAccount field's value. +func (s *ListStackInstanceResourceDriftsInput) SetStackInstanceAccount(v string) *ListStackInstanceResourceDriftsInput { + s.StackInstanceAccount = &v + return s +} + +// SetStackInstanceRegion sets the StackInstanceRegion field's value. +func (s *ListStackInstanceResourceDriftsInput) SetStackInstanceRegion(v string) *ListStackInstanceResourceDriftsInput { + s.StackInstanceRegion = &v + return s +} + +// SetStackInstanceResourceDriftStatuses sets the StackInstanceResourceDriftStatuses field's value. +func (s *ListStackInstanceResourceDriftsInput) SetStackInstanceResourceDriftStatuses(v []*string) *ListStackInstanceResourceDriftsInput { + s.StackInstanceResourceDriftStatuses = v + return s +} + +// SetStackSetName sets the StackSetName field's value. +func (s *ListStackInstanceResourceDriftsInput) SetStackSetName(v string) *ListStackInstanceResourceDriftsInput { + s.StackSetName = &v + return s +} + +type ListStackInstanceResourceDriftsOutput struct { + _ struct{} `type:"structure"` + + // If the previous paginated request didn't return all of the remaining results, + // the response object's NextToken parameter value is set to a token. To retrieve + // the next set of results, call this action again and assign that token to + // the request object's NextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `min:"1" type:"string"` + + // A list of StackInstanceResourceDriftSummary structures that contain information + // about the specified stack instances. + Summaries []*StackInstanceResourceDriftsSummary `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStackInstanceResourceDriftsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStackInstanceResourceDriftsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStackInstanceResourceDriftsOutput) SetNextToken(v string) *ListStackInstanceResourceDriftsOutput { + s.NextToken = &v + return s +} + +// SetSummaries sets the Summaries field's value. +func (s *ListStackInstanceResourceDriftsOutput) SetSummaries(v []*StackInstanceResourceDriftsSummary) *ListStackInstanceResourceDriftsOutput { + s.Summaries = v + return s +} + type ListStackInstancesInput struct { _ struct{} `type:"structure"` @@ -17416,7 +17719,7 @@ func (s *ResourceToImport) SetResourceType(v string) *ResourceToImport { // your application during stack creation and updating, and to roll back that // operation if the application breaches the threshold of any of the alarms // you've specified. For more information, see Monitor and Roll Back Stack Operations -// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html). +// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html). type RollbackConfiguration struct { _ struct{} `type:"structure"` @@ -18196,15 +18499,15 @@ type Stack struct { // Information about whether a stack's actual configuration differs, or has // drifted, from its expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see - // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackDriftInformation `type:"structure"` // Whether termination protection is enabled for the stack. // - // For nested stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), + // For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), // termination protection is set on the root stack and can't be changed directly // on the nested stack. For more information, see Protecting a Stack From Being - // Deleted (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) + // Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) // in the CloudFormation User Guide. EnableTerminationProtection *bool `type:"boolean"` @@ -18226,7 +18529,7 @@ type Stack struct { // ID of the direct parent of this stack. For the first level of nested stacks, // the root stack is also the parent stack. // - // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. ParentId *string `type:"string"` @@ -18242,7 +18545,7 @@ type Stack struct { // For nested stacks--stacks created as resources for another stack--the stack // ID of the top-level stack to which the nested stack ultimately belongs. // - // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. RootId *string `type:"string"` @@ -19017,6 +19320,131 @@ func (s *StackInstanceFilter) SetValues(v string) *StackInstanceFilter { return s } +// The structure containing summary information about resource drifts for a +// stack instance. +type StackInstanceResourceDriftsSummary struct { + _ struct{} `type:"structure"` + + // The logical name of the resource specified in the template. + // + // LogicalResourceId is a required field + LogicalResourceId *string `type:"string" required:"true"` + + // The name or unique identifier that corresponds to a physical instance ID + // of a resource supported by CloudFormation. + PhysicalResourceId *string `type:"string"` + + // Context information that enables CloudFormation to uniquely identify a resource. + // CloudFormation uses context key-value pairs in cases where a resource's logical + // and physical IDs aren't enough to uniquely identify that resource. Each context + // key-value pair specifies a unique resource that contains the targeted resource. + PhysicalResourceIdContext []*PhysicalResourceIdContextKeyValuePair `type:"list"` + + // Status of the actual configuration of the resource compared to its expected + // configuration. These will be present only for resources whose StackInstanceResourceDriftStatus + // is MODIFIED. + PropertyDifferences []*PropertyDifference `type:"list"` + + // Type of resource. For more information, go to Amazon Web Services Resource + // Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // in the CloudFormation User Guide. + // + // ResourceType is a required field + ResourceType *string `min:"1" type:"string" required:"true"` + + // The ID of the stack instance. + // + // StackId is a required field + StackId *string `type:"string" required:"true"` + + // The drift status of the resource in a stack instance. + // + // * DELETED: The resource differs from its expected template configuration + // in that the resource has been deleted. + // + // * MODIFIED: One or more resource properties differ from their expected + // template values. + // + // * IN_SYNC: The resource's actual configuration matches its expected template + // configuration. + // + // * NOT_CHECKED: CloudFormation doesn't currently return this value. + // + // StackResourceDriftStatus is a required field + StackResourceDriftStatus *string `type:"string" required:"true" enum:"StackResourceDriftStatus"` + + // Time at which the stack instance drift detection operation was initiated. + // + // Timestamp is a required field + Timestamp *time.Time `type:"timestamp" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StackInstanceResourceDriftsSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StackInstanceResourceDriftsSummary) GoString() string { + return s.String() +} + +// SetLogicalResourceId sets the LogicalResourceId field's value. +func (s *StackInstanceResourceDriftsSummary) SetLogicalResourceId(v string) *StackInstanceResourceDriftsSummary { + s.LogicalResourceId = &v + return s +} + +// SetPhysicalResourceId sets the PhysicalResourceId field's value. +func (s *StackInstanceResourceDriftsSummary) SetPhysicalResourceId(v string) *StackInstanceResourceDriftsSummary { + s.PhysicalResourceId = &v + return s +} + +// SetPhysicalResourceIdContext sets the PhysicalResourceIdContext field's value. +func (s *StackInstanceResourceDriftsSummary) SetPhysicalResourceIdContext(v []*PhysicalResourceIdContextKeyValuePair) *StackInstanceResourceDriftsSummary { + s.PhysicalResourceIdContext = v + return s +} + +// SetPropertyDifferences sets the PropertyDifferences field's value. +func (s *StackInstanceResourceDriftsSummary) SetPropertyDifferences(v []*PropertyDifference) *StackInstanceResourceDriftsSummary { + s.PropertyDifferences = v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *StackInstanceResourceDriftsSummary) SetResourceType(v string) *StackInstanceResourceDriftsSummary { + s.ResourceType = &v + return s +} + +// SetStackId sets the StackId field's value. +func (s *StackInstanceResourceDriftsSummary) SetStackId(v string) *StackInstanceResourceDriftsSummary { + s.StackId = &v + return s +} + +// SetStackResourceDriftStatus sets the StackResourceDriftStatus field's value. +func (s *StackInstanceResourceDriftsSummary) SetStackResourceDriftStatus(v string) *StackInstanceResourceDriftsSummary { + s.StackResourceDriftStatus = &v + return s +} + +// SetTimestamp sets the Timestamp field's value. +func (s *StackInstanceResourceDriftsSummary) SetTimestamp(v time.Time) *StackInstanceResourceDriftsSummary { + s.Timestamp = &v + return s +} + // The structure that contains summary information about a stack instance. type StackInstanceSummary struct { _ struct{} `type:"structure"` @@ -19183,7 +19611,7 @@ type StackResource struct { // Information about whether the resource's actual configuration differs, or // has drifted, from its expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see - // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformation `type:"structure"` // The logical name of the resource specified in the template. @@ -19320,7 +19748,7 @@ type StackResourceDetail struct { // Information about whether the resource's actual configuration differs, or // has drifted, from its expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see - // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformation `type:"structure"` // Time the status was updated. @@ -19466,7 +19894,7 @@ func (s *StackResourceDetail) SetStackName(v string) *StackResourceDetail { // // Resources that don't currently support drift detection can't be checked. // For a list of resources that support drift detection, see Resources that -// Support Drift Detection (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). +// Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). // // Use DetectStackResourceDrift to detect drift on individual resources, or // DetectStackDrift to detect drift on all resources in a given stack that support @@ -19754,7 +20182,7 @@ type StackResourceSummary struct { // Information about whether the resource's actual configuration differs, or // has drifted, from its expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see - // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformationSummary `type:"structure"` // Time the status was updated. @@ -19870,7 +20298,7 @@ type StackSet struct { // // Use customized administrator roles to control which users or groups can manage // specific stack sets within the same administrator account. For more information, - // see Prerequisites: Granting Permissions for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // see Prerequisites: Granting Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` @@ -20233,7 +20661,7 @@ type StackSetOperation struct { // // Use customized administrator roles to control which users or groups can manage // specific stack sets within the same administrator account. For more information, - // see Define Permissions for Multiple Administrators (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // see Define Permissions for Multiple Administrators (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` @@ -20972,7 +21400,7 @@ type StackSummary struct { // Summarizes information about whether a stack's actual configuration differs, // or has drifted, from its expected configuration, as defined in the stack // template and any values specified as template parameters. For more information, - // see Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackDriftInformationSummary `type:"structure"` // The time the stack was last updated. This field will only be returned if @@ -20983,14 +21411,14 @@ type StackSummary struct { // ID of the direct parent of this stack. For the first level of nested stacks, // the root stack is also the parent stack. // - // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. ParentId *string `type:"string"` // For nested stacks--stacks created as resources for another stack--the stack // ID of the top-level stack to which the nested stack ultimately belongs. // - // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. RootId *string `type:"string"` @@ -22121,7 +22549,7 @@ type UpdateStackInput struct { // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in CloudFormation - // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). + // Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform // custom processing on templates; this can include simple actions like find-and-replace @@ -22131,8 +22559,8 @@ type UpdateStackInput struct { // before actually updating the stack. If your stack template contains one // or more macros, and you choose to update a stack directly from the processed // template, without first reviewing the resulting changes in a change set, - // you must acknowledge this capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // you must acknowledge this capability. This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by CloudFormation. If you want to // update a stack from a stack template that contains macros and nested stacks, // you must update the stack directly from the template using this capability. @@ -22141,7 +22569,7 @@ type UpdateStackInput struct { // on an underlying Lambda service function for processing stack templates. // Be aware that the Lambda function owner can update the function operation // without CloudFormation being notified. For more information, see Using - // CloudFormation Macros to Perform Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // CloudFormation Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []*string `type:"list" enum:"Capability"` // A unique identifier for this UpdateStack request. Specify this token if you @@ -22734,7 +23162,7 @@ type UpdateStackSetInput struct { // Specify an IAM role only if you are using customized administrator roles // to control which users or groups can manage specific stack sets within the // same administrator account. For more information, see Granting Permissions - // for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) // in the CloudFormation User Guide. // // If you specified a customized administrator role when you created the stack @@ -22788,17 +23216,17 @@ type UpdateStackSetInput struct { // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in CloudFormation - // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). + // Templates (https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack // set template references one or more macros, you must update the stack // set directly from the processed template, without first reviewing the // resulting changes in a change set. To update the stack set directly, you // must acknowledge this capability. For more information, see Using CloudFormation - // Macros to Perform Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html). // Stack sets with service-managed permissions do not currently support the - // use of macros in templates. (This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html) // transforms, which are macros hosted by CloudFormation.) Even if you specify // this capability for a stack set with service-managed permissions, if you // reference a macro in your template the stack set operation will fail. @@ -24415,6 +24843,9 @@ const ( // StackInstanceFilterNameLastOperationId is a StackInstanceFilterName enum value StackInstanceFilterNameLastOperationId = "LAST_OPERATION_ID" + + // StackInstanceFilterNameDriftStatus is a StackInstanceFilterName enum value + StackInstanceFilterNameDriftStatus = "DRIFT_STATUS" ) // StackInstanceFilterName_Values returns all elements of the StackInstanceFilterName enum @@ -24422,6 +24853,7 @@ func StackInstanceFilterName_Values() []string { return []string{ StackInstanceFilterNameDetailedStatus, StackInstanceFilterNameLastOperationId, + StackInstanceFilterNameDriftStatus, } } diff --git a/service/cloudformation/cloudformationiface/interface.go b/service/cloudformation/cloudformationiface/interface.go index c9d6a91ca2e..c05bf90a16a 100644 --- a/service/cloudformation/cloudformationiface/interface.go +++ b/service/cloudformation/cloudformationiface/interface.go @@ -257,6 +257,10 @@ type CloudFormationAPI interface { ListImportsPages(*cloudformation.ListImportsInput, func(*cloudformation.ListImportsOutput, bool) bool) error ListImportsPagesWithContext(aws.Context, *cloudformation.ListImportsInput, func(*cloudformation.ListImportsOutput, bool) bool, ...request.Option) error + ListStackInstanceResourceDrifts(*cloudformation.ListStackInstanceResourceDriftsInput) (*cloudformation.ListStackInstanceResourceDriftsOutput, error) + ListStackInstanceResourceDriftsWithContext(aws.Context, *cloudformation.ListStackInstanceResourceDriftsInput, ...request.Option) (*cloudformation.ListStackInstanceResourceDriftsOutput, error) + ListStackInstanceResourceDriftsRequest(*cloudformation.ListStackInstanceResourceDriftsInput) (*request.Request, *cloudformation.ListStackInstanceResourceDriftsOutput) + ListStackInstances(*cloudformation.ListStackInstancesInput) (*cloudformation.ListStackInstancesOutput, error) ListStackInstancesWithContext(aws.Context, *cloudformation.ListStackInstancesInput, ...request.Option) (*cloudformation.ListStackInstancesOutput, error) ListStackInstancesRequest(*cloudformation.ListStackInstancesInput) (*request.Request, *cloudformation.ListStackInstancesOutput) diff --git a/service/costexplorer/api.go b/service/costexplorer/api.go index eb7929ff068..a48e7f00e86 100644 --- a/service/costexplorer/api.go +++ b/service/costexplorer/api.go @@ -1727,6 +1727,90 @@ func (c *CostExplorer) GetRightsizingRecommendationWithContext(ctx aws.Context, return out, req.Send() } +const opGetSavingsPlanPurchaseRecommendationDetails = "GetSavingsPlanPurchaseRecommendationDetails" + +// GetSavingsPlanPurchaseRecommendationDetailsRequest generates a "aws/request.Request" representing the +// client's request for the GetSavingsPlanPurchaseRecommendationDetails operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetSavingsPlanPurchaseRecommendationDetails for more information on using the GetSavingsPlanPurchaseRecommendationDetails +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetSavingsPlanPurchaseRecommendationDetailsRequest method. +// req, resp := client.GetSavingsPlanPurchaseRecommendationDetailsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetSavingsPlanPurchaseRecommendationDetails +func (c *CostExplorer) GetSavingsPlanPurchaseRecommendationDetailsRequest(input *GetSavingsPlanPurchaseRecommendationDetailsInput) (req *request.Request, output *GetSavingsPlanPurchaseRecommendationDetailsOutput) { + op := &request.Operation{ + Name: opGetSavingsPlanPurchaseRecommendationDetails, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetSavingsPlanPurchaseRecommendationDetailsInput{} + } + + output = &GetSavingsPlanPurchaseRecommendationDetailsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetSavingsPlanPurchaseRecommendationDetails API operation for AWS Cost Explorer Service. +// +// Retrieves the details for a Savings Plan recommendation. These details include +// the hourly data-points that construct the new cost, coverage, and utilization +// charts. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Cost Explorer Service's +// API operation GetSavingsPlanPurchaseRecommendationDetails for usage and error information. +// +// Returned Error Types: +// +// - LimitExceededException +// You made too many calls in a short period of time. Try again later. +// +// - DataUnavailableException +// The requested data is unavailable. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetSavingsPlanPurchaseRecommendationDetails +func (c *CostExplorer) GetSavingsPlanPurchaseRecommendationDetails(input *GetSavingsPlanPurchaseRecommendationDetailsInput) (*GetSavingsPlanPurchaseRecommendationDetailsOutput, error) { + req, out := c.GetSavingsPlanPurchaseRecommendationDetailsRequest(input) + return out, req.Send() +} + +// GetSavingsPlanPurchaseRecommendationDetailsWithContext is the same as GetSavingsPlanPurchaseRecommendationDetails with the addition of +// the ability to pass a context and additional request options. +// +// See GetSavingsPlanPurchaseRecommendationDetails for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CostExplorer) GetSavingsPlanPurchaseRecommendationDetailsWithContext(ctx aws.Context, input *GetSavingsPlanPurchaseRecommendationDetailsInput, opts ...request.Option) (*GetSavingsPlanPurchaseRecommendationDetailsOutput, error) { + req, out := c.GetSavingsPlanPurchaseRecommendationDetailsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetSavingsPlansCoverage = "GetSavingsPlansCoverage" // GetSavingsPlansCoverageRequest generates a "aws/request.Request" representing the @@ -2727,6 +2811,9 @@ func (c *CostExplorer) ListSavingsPlansPurchaseRecommendationGenerationRequest(i // - InvalidNextTokenException // The pagination token is invalid. Try again without a pagination token. // +// - DataUnavailableException +// The requested data is unavailable. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListSavingsPlansPurchaseRecommendationGeneration func (c *CostExplorer) ListSavingsPlansPurchaseRecommendationGeneration(input *ListSavingsPlansPurchaseRecommendationGenerationInput) (*ListSavingsPlansPurchaseRecommendationGenerationOutput, error) { req, out := c.ListSavingsPlansPurchaseRecommendationGenerationRequest(input) @@ -2981,6 +3068,9 @@ func (c *CostExplorer) StartSavingsPlansPurchaseRecommendationGenerationRequest( // - GenerationExistsException // A request to generate a recommendation is already in progress. // +// - DataUnavailableException +// The requested data is unavailable. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/StartSavingsPlansPurchaseRecommendationGeneration func (c *CostExplorer) StartSavingsPlansPurchaseRecommendationGeneration(input *StartSavingsPlansPurchaseRecommendationGenerationInput) (*StartSavingsPlansPurchaseRecommendationGenerationOutput, error) { req, out := c.StartSavingsPlansPurchaseRecommendationGenerationRequest(input) @@ -3309,7 +3399,12 @@ func (c *CostExplorer) UpdateAnomalySubscriptionRequest(input *UpdateAnomalySubs // UpdateAnomalySubscription API operation for AWS Cost Explorer Service. // -// Updates an existing cost anomaly monitor subscription. +// Updates an existing cost anomaly subscription. Specify the fields that you +// want to update. Omitted fields are unchanged. +// +// The JSON below describes the generic construct for each type. See Request +// Parameters (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_UpdateAnomalySubscription.html#API_UpdateAnomalySubscription_RequestParameters) +// for possible values as they apply to AnomalySubscription. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3736,13 +3831,13 @@ type AnomalyMonitor struct { // OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is // a full name (for example, REGION==US East (N. Virginia). The corresponding // Expression for this example is as follows: { "Dimensions": { "Key": "REGION", - // "Values": [ "us-east-1", “us-west-1” ] } } As shown in the previous - // example, lists of dimension values are combined with OR when applying - // the filter. You can also set different match options to further control - // how the filter behaves. Not all APIs support match options. Refer to the - // documentation for each specific API to see what is supported. For example, - // you can filter for linked account names that start with “a”. The corresponding - // Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", + // "Values": [ "us-east-1", "us-west-1" ] } } As shown in the previous example, + // lists of dimension values are combined with OR when applying the filter. + // You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation + // for each specific API to see what is supported. For example, you can filter + // for linked account names that start with "a". The corresponding Expression + // for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", // "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } } // // * Compound Expression types with logical operations. You can use multiple @@ -3915,17 +4010,31 @@ func (s *AnomalyScore) SetMaxScore(v float64) *AnomalyScore { return s } -// The association between a monitor, threshold, and list of subscribers used -// to deliver notifications about anomalies detected by a monitor that exceeds -// a threshold. The content consists of the detailed metadata and the current -// status of the AnomalySubscription object. +// An AnomalySubscription resource (also referred to as an alert subscription) +// sends notifications about specific anomalies that meet an alerting criteria +// defined by you. +// +// You can specify the frequency of the alerts and the subscribers to notify. +// +// Anomaly subscriptions can be associated with one or more AnomalyMonitor (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html) +// resources, and they only send notifications about anomalies detected by those +// associated monitors. You can also configure a threshold to further control +// which anomalies are included in the notifications. +// +// Anomalies that don’t exceed the chosen threshold and therefore don’t +// trigger notifications from an anomaly subscription will still be available +// on the console and from the GetAnomalies (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetAnomalies.html) +// API. type AnomalySubscription struct { _ struct{} `type:"structure"` // Your unique account identifier. AccountId *string `type:"string"` - // The frequency that anomaly reports are sent over email. + // The frequency that anomaly notifications are sent. Notifications are sent + // either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE + // frequency). For more information, see Creating an Amazon SNS topic for anomaly + // notifications (https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html). // // Frequency is a required field Frequency *string `type:"string" required:"true" enum:"AnomalySubscriptionFrequency"` @@ -3950,12 +4059,15 @@ type AnomalySubscription struct { // (deprecated) // - // The dollar value that triggers a notification if the threshold is exceeded. + // An absolute dollar value that must be exceeded by the anomaly's total impact + // (see Impact (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) + // for more details) for an anomaly notification to be generated. // // This field has been deprecated. To specify a threshold, use ThresholdExpression. // Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression. // - // One of Threshold or ThresholdExpression is required for this resource. + // One of Threshold or ThresholdExpression is required for this resource. You + // cannot specify both. // // Deprecated: Threshold has been deprecated in favor of ThresholdExpression Threshold *float64 `deprecated:"true" type:"double"` @@ -3963,11 +4075,15 @@ type AnomalySubscription struct { // An Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object used to specify the anomalies that you want to generate alerts for. // This supports dimensions and nested expressions. The supported dimensions - // are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE. The - // supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL - // is required. Values must be numbers between 0 and 10,000,000,000. + // are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding + // to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see + // Impact (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) + // for more details). The supported nested expression types are AND and OR. + // The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers + // between 0 and 10,000,000,000 in string format. // - // One of Threshold or ThresholdExpression is required for this resource. + // One of Threshold or ThresholdExpression is required for this resource. You + // cannot specify both. // // The following are examples of valid ThresholdExpressions: // @@ -4604,10 +4720,7 @@ type CostCategoryRule struct { // An Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object used to categorize costs. This supports dimensions, tags, and nested // expressions. Currently the only dimensions supported are LINKED_ACCOUNT, - // SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME. - // - // Root level OR isn't supported. We recommend that you create a separate rule - // instead. + // SERVICE_CODE, RECORD_TYPE, LINKED_ACCOUNT_NAME, REGION, and USAGE_TYPE. // // RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported // for Cost Category expressions. This dimension uses different terms, depending @@ -6964,13 +7077,13 @@ func (s *ElastiCacheInstanceDetails) SetSizeFlexEligible(v bool) *ElastiCacheIns // OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is // a full name (for example, REGION==US East (N. Virginia). The corresponding // Expression for this example is as follows: { "Dimensions": { "Key": "REGION", -// "Values": [ "us-east-1", “us-west-1” ] } } As shown in the previous -// example, lists of dimension values are combined with OR when applying -// the filter. You can also set different match options to further control -// how the filter behaves. Not all APIs support match options. Refer to the -// documentation for each specific API to see what is supported. For example, -// you can filter for linked account names that start with “a”. The corresponding -// Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", +// "Values": [ "us-east-1", "us-west-1" ] } } As shown in the previous example, +// lists of dimension values are combined with OR when applying the filter. +// You can also set different match options to further control how the filter +// behaves. Not all APIs support match options. Refer to the documentation +// for each specific API to see what is supported. For example, you can filter +// for linked account names that start with "a". The corresponding Expression +// for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", // "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } } // // - Compound Expression types with logical operations. You can use multiple @@ -8093,13 +8206,13 @@ type GetCostCategoriesInput struct { // OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is // a full name (for example, REGION==US East (N. Virginia). The corresponding // Expression for this example is as follows: { "Dimensions": { "Key": "REGION", - // "Values": [ "us-east-1", “us-west-1” ] } } As shown in the previous - // example, lists of dimension values are combined with OR when applying - // the filter. You can also set different match options to further control - // how the filter behaves. Not all APIs support match options. Refer to the - // documentation for each specific API to see what is supported. For example, - // you can filter for linked account names that start with “a”. The corresponding - // Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", + // "Values": [ "us-east-1", "us-west-1" ] } } As shown in the previous example, + // lists of dimension values are combined with OR when applying the filter. + // You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation + // for each specific API to see what is supported. For example, you can filter + // for linked account names that start with "a". The corresponding Expression + // for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", // "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } } // // * Compound Expression types with logical operations. You can use multiple @@ -8730,13 +8843,13 @@ type GetDimensionValuesInput struct { // OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is // a full name (for example, REGION==US East (N. Virginia). The corresponding // Expression for this example is as follows: { "Dimensions": { "Key": "REGION", - // "Values": [ "us-east-1", “us-west-1” ] } } As shown in the previous - // example, lists of dimension values are combined with OR when applying - // the filter. You can also set different match options to further control - // how the filter behaves. Not all APIs support match options. Refer to the - // documentation for each specific API to see what is supported. For example, - // you can filter for linked account names that start with “a”. The corresponding - // Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", + // "Values": [ "us-east-1", "us-west-1" ] } } As shown in the previous example, + // lists of dimension values are combined with OR when applying the filter. + // You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation + // for each specific API to see what is supported. For example, you can filter + // for linked account names that start with "a". The corresponding Expression + // for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", // "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } } // // * Compound Expression types with logical operations. You can use multiple @@ -9387,13 +9500,13 @@ type GetReservationPurchaseRecommendationInput struct { // OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is // a full name (for example, REGION==US East (N. Virginia). The corresponding // Expression for this example is as follows: { "Dimensions": { "Key": "REGION", - // "Values": [ "us-east-1", “us-west-1” ] } } As shown in the previous - // example, lists of dimension values are combined with OR when applying - // the filter. You can also set different match options to further control - // how the filter behaves. Not all APIs support match options. Refer to the - // documentation for each specific API to see what is supported. For example, - // you can filter for linked account names that start with “a”. The corresponding - // Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", + // "Values": [ "us-east-1", "us-west-1" ] } } As shown in the previous example, + // lists of dimension values are combined with OR when applying the filter. + // You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation + // for each specific API to see what is supported. For example, you can filter + // for linked account names that start with "a". The corresponding Expression + // for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", // "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } } // // * Compound Expression types with logical operations. You can use multiple @@ -9872,13 +9985,13 @@ type GetRightsizingRecommendationInput struct { // OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is // a full name (for example, REGION==US East (N. Virginia). The corresponding // Expression for this example is as follows: { "Dimensions": { "Key": "REGION", - // "Values": [ "us-east-1", “us-west-1” ] } } As shown in the previous - // example, lists of dimension values are combined with OR when applying - // the filter. You can also set different match options to further control - // how the filter behaves. Not all APIs support match options. Refer to the - // documentation for each specific API to see what is supported. For example, - // you can filter for linked account names that start with “a”. The corresponding - // Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", + // "Values": [ "us-east-1", "us-west-1" ] } } As shown in the previous example, + // lists of dimension values are combined with OR when applying the filter. + // You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation + // for each specific API to see what is supported. For example, you can filter + // for linked account names that start with "a". The corresponding Expression + // for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", // "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } } // // * Compound Expression types with logical operations. You can use multiple @@ -10064,6 +10177,95 @@ func (s *GetRightsizingRecommendationOutput) SetSummary(v *RightsizingRecommenda return s } +type GetSavingsPlanPurchaseRecommendationDetailsInput struct { + _ struct{} `type:"structure"` + + // The ID that is associated with the Savings Plan recommendation. + // + // RecommendationDetailId is a required field + RecommendationDetailId *string `min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetSavingsPlanPurchaseRecommendationDetailsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetSavingsPlanPurchaseRecommendationDetailsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetSavingsPlanPurchaseRecommendationDetailsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetSavingsPlanPurchaseRecommendationDetailsInput"} + if s.RecommendationDetailId == nil { + invalidParams.Add(request.NewErrParamRequired("RecommendationDetailId")) + } + if s.RecommendationDetailId != nil && len(*s.RecommendationDetailId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("RecommendationDetailId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRecommendationDetailId sets the RecommendationDetailId field's value. +func (s *GetSavingsPlanPurchaseRecommendationDetailsInput) SetRecommendationDetailId(v string) *GetSavingsPlanPurchaseRecommendationDetailsInput { + s.RecommendationDetailId = &v + return s +} + +type GetSavingsPlanPurchaseRecommendationDetailsOutput struct { + _ struct{} `type:"structure"` + + // Contains detailed information about a specific Savings Plan recommendation. + RecommendationDetailData *RecommendationDetailData `type:"structure"` + + // The ID that is associated with the Savings Plan recommendation. + RecommendationDetailId *string `min:"36" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetSavingsPlanPurchaseRecommendationDetailsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetSavingsPlanPurchaseRecommendationDetailsOutput) GoString() string { + return s.String() +} + +// SetRecommendationDetailData sets the RecommendationDetailData field's value. +func (s *GetSavingsPlanPurchaseRecommendationDetailsOutput) SetRecommendationDetailData(v *RecommendationDetailData) *GetSavingsPlanPurchaseRecommendationDetailsOutput { + s.RecommendationDetailData = v + return s +} + +// SetRecommendationDetailId sets the RecommendationDetailId field's value. +func (s *GetSavingsPlanPurchaseRecommendationDetailsOutput) SetRecommendationDetailId(v string) *GetSavingsPlanPurchaseRecommendationDetailsOutput { + s.RecommendationDetailId = &v + return s +} + type GetSavingsPlansCoverageInput struct { _ struct{} `type:"structure"` @@ -10872,13 +11074,13 @@ type GetTagsInput struct { // OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is // a full name (for example, REGION==US East (N. Virginia). The corresponding // Expression for this example is as follows: { "Dimensions": { "Key": "REGION", - // "Values": [ "us-east-1", “us-west-1” ] } } As shown in the previous - // example, lists of dimension values are combined with OR when applying - // the filter. You can also set different match options to further control - // how the filter behaves. Not all APIs support match options. Refer to the - // documentation for each specific API to see what is supported. For example, - // you can filter for linked account names that start with “a”. The corresponding - // Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", + // "Values": [ "us-east-1", "us-west-1" ] } } As shown in the previous example, + // lists of dimension values are combined with OR when applying the filter. + // You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation + // for each specific API to see what is supported. For example, you can filter + // for linked account names that start with "a". The corresponding Expression + // for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", // "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } } // // * Compound Expression types with logical operations. You can use multiple @@ -12448,6 +12650,378 @@ func (s *RDSInstanceDetails) SetSizeFlexEligible(v bool) *RDSInstanceDetails { return s } +// The details and metrics for the given recommendation. +type RecommendationDetailData struct { + _ struct{} `type:"structure"` + + // The AccountID that the recommendation is generated for. + AccountId *string `type:"string"` + + // The account scope that you want your recommendations for. Amazon Web Services + // calculates recommendations including the management account and member accounts + // if the value is set to PAYER. If the value is LINKED, recommendations are + // calculated for individual member accounts only. + AccountScope *string `type:"string" enum:"AccountScope"` + + // The currency code that Amazon Web Services used to generate the recommendation + // and present potential savings. + CurrencyCode *string `type:"string"` + + // The average value of hourly coverage over the lookback period. + CurrentAverageCoverage *string `type:"string"` + + // The average value of hourly On-Demand spend over the lookback period of the + // applicable usage type. + CurrentAverageHourlyOnDemandSpend *string `type:"string"` + + // The highest value of hourly On-Demand spend over the lookback period of the + // applicable usage type. + CurrentMaximumHourlyOnDemandSpend *string `type:"string"` + + // The lowest value of hourly On-Demand spend over the lookback period of the + // applicable usage type. + CurrentMinimumHourlyOnDemandSpend *string `type:"string"` + + // The estimated coverage of the recommended Savings Plan. + EstimatedAverageCoverage *string `type:"string"` + + // The estimated utilization of the recommended Savings Plan. + EstimatedAverageUtilization *string `type:"string"` + + // The estimated monthly savings amount based on the recommended Savings Plan. + EstimatedMonthlySavingsAmount *string `type:"string"` + + // The remaining On-Demand cost estimated to not be covered by the recommended + // Savings Plan, over the length of the lookback period. + EstimatedOnDemandCost *string `type:"string"` + + // The estimated On-Demand costs you expect with no additional commitment, based + // on your usage of the selected time period and the Savings Plan you own. + EstimatedOnDemandCostWithCurrentCommitment *string `type:"string"` + + // The estimated return on investment that's based on the recommended Savings + // Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100. + EstimatedROI *string `type:"string"` + + // The cost of the recommended Savings Plan over the length of the lookback + // period. + EstimatedSPCost *string `type:"string"` + + // The estimated savings amount that's based on the recommended Savings Plan + // over the length of the lookback period. + EstimatedSavingsAmount *string `type:"string"` + + // The estimated savings percentage relative to the total cost of applicable + // On-Demand usage over the lookback period. + EstimatedSavingsPercentage *string `type:"string"` + + // The existing hourly commitment for the Savings Plan type. + ExistingHourlyCommitment *string `type:"string"` + + // The period of time that you want the usage and costs for. + GenerationTimestamp *string `min:"20" type:"string"` + + // The recommended hourly commitment level for the Savings Plan type and the + // configuration that's based on the usage during the lookback period. + HourlyCommitmentToPurchase *string `type:"string"` + + // The instance family of the recommended Savings Plan. + InstanceFamily *string `type:"string"` + + // The period of time that you want the usage and costs for. + LatestUsageTimestamp *string `min:"20" type:"string"` + + // How many days of previous usage that Amazon Web Services considers when making + // this recommendation. + LookbackPeriodInDays *string `type:"string" enum:"LookbackPeriodInDays"` + + // The related hourly cost, coverage, and utilization metrics over the lookback + // period. + MetricsOverLookbackPeriod []*RecommendationDetailHourlyMetrics `type:"list"` + + // The unique ID that's used to distinguish Savings Plans from one another. + OfferingId *string `type:"string"` + + // The payment option for the commitment (for example, All Upfront or No Upfront). + PaymentOption *string `type:"string" enum:"PaymentOption"` + + // The region the recommendation is generated for. + Region *string `type:"string"` + + // The requested Savings Plan recommendation type. + SavingsPlansType *string `type:"string" enum:"SupportedSavingsPlansType"` + + // The term of the commitment in years. + TermInYears *string `type:"string" enum:"TermInYears"` + + // The upfront cost of the recommended Savings Plan, based on the selected payment + // option. + UpfrontCost *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationDetailData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationDetailData) GoString() string { + return s.String() +} + +// SetAccountId sets the AccountId field's value. +func (s *RecommendationDetailData) SetAccountId(v string) *RecommendationDetailData { + s.AccountId = &v + return s +} + +// SetAccountScope sets the AccountScope field's value. +func (s *RecommendationDetailData) SetAccountScope(v string) *RecommendationDetailData { + s.AccountScope = &v + return s +} + +// SetCurrencyCode sets the CurrencyCode field's value. +func (s *RecommendationDetailData) SetCurrencyCode(v string) *RecommendationDetailData { + s.CurrencyCode = &v + return s +} + +// SetCurrentAverageCoverage sets the CurrentAverageCoverage field's value. +func (s *RecommendationDetailData) SetCurrentAverageCoverage(v string) *RecommendationDetailData { + s.CurrentAverageCoverage = &v + return s +} + +// SetCurrentAverageHourlyOnDemandSpend sets the CurrentAverageHourlyOnDemandSpend field's value. +func (s *RecommendationDetailData) SetCurrentAverageHourlyOnDemandSpend(v string) *RecommendationDetailData { + s.CurrentAverageHourlyOnDemandSpend = &v + return s +} + +// SetCurrentMaximumHourlyOnDemandSpend sets the CurrentMaximumHourlyOnDemandSpend field's value. +func (s *RecommendationDetailData) SetCurrentMaximumHourlyOnDemandSpend(v string) *RecommendationDetailData { + s.CurrentMaximumHourlyOnDemandSpend = &v + return s +} + +// SetCurrentMinimumHourlyOnDemandSpend sets the CurrentMinimumHourlyOnDemandSpend field's value. +func (s *RecommendationDetailData) SetCurrentMinimumHourlyOnDemandSpend(v string) *RecommendationDetailData { + s.CurrentMinimumHourlyOnDemandSpend = &v + return s +} + +// SetEstimatedAverageCoverage sets the EstimatedAverageCoverage field's value. +func (s *RecommendationDetailData) SetEstimatedAverageCoverage(v string) *RecommendationDetailData { + s.EstimatedAverageCoverage = &v + return s +} + +// SetEstimatedAverageUtilization sets the EstimatedAverageUtilization field's value. +func (s *RecommendationDetailData) SetEstimatedAverageUtilization(v string) *RecommendationDetailData { + s.EstimatedAverageUtilization = &v + return s +} + +// SetEstimatedMonthlySavingsAmount sets the EstimatedMonthlySavingsAmount field's value. +func (s *RecommendationDetailData) SetEstimatedMonthlySavingsAmount(v string) *RecommendationDetailData { + s.EstimatedMonthlySavingsAmount = &v + return s +} + +// SetEstimatedOnDemandCost sets the EstimatedOnDemandCost field's value. +func (s *RecommendationDetailData) SetEstimatedOnDemandCost(v string) *RecommendationDetailData { + s.EstimatedOnDemandCost = &v + return s +} + +// SetEstimatedOnDemandCostWithCurrentCommitment sets the EstimatedOnDemandCostWithCurrentCommitment field's value. +func (s *RecommendationDetailData) SetEstimatedOnDemandCostWithCurrentCommitment(v string) *RecommendationDetailData { + s.EstimatedOnDemandCostWithCurrentCommitment = &v + return s +} + +// SetEstimatedROI sets the EstimatedROI field's value. +func (s *RecommendationDetailData) SetEstimatedROI(v string) *RecommendationDetailData { + s.EstimatedROI = &v + return s +} + +// SetEstimatedSPCost sets the EstimatedSPCost field's value. +func (s *RecommendationDetailData) SetEstimatedSPCost(v string) *RecommendationDetailData { + s.EstimatedSPCost = &v + return s +} + +// SetEstimatedSavingsAmount sets the EstimatedSavingsAmount field's value. +func (s *RecommendationDetailData) SetEstimatedSavingsAmount(v string) *RecommendationDetailData { + s.EstimatedSavingsAmount = &v + return s +} + +// SetEstimatedSavingsPercentage sets the EstimatedSavingsPercentage field's value. +func (s *RecommendationDetailData) SetEstimatedSavingsPercentage(v string) *RecommendationDetailData { + s.EstimatedSavingsPercentage = &v + return s +} + +// SetExistingHourlyCommitment sets the ExistingHourlyCommitment field's value. +func (s *RecommendationDetailData) SetExistingHourlyCommitment(v string) *RecommendationDetailData { + s.ExistingHourlyCommitment = &v + return s +} + +// SetGenerationTimestamp sets the GenerationTimestamp field's value. +func (s *RecommendationDetailData) SetGenerationTimestamp(v string) *RecommendationDetailData { + s.GenerationTimestamp = &v + return s +} + +// SetHourlyCommitmentToPurchase sets the HourlyCommitmentToPurchase field's value. +func (s *RecommendationDetailData) SetHourlyCommitmentToPurchase(v string) *RecommendationDetailData { + s.HourlyCommitmentToPurchase = &v + return s +} + +// SetInstanceFamily sets the InstanceFamily field's value. +func (s *RecommendationDetailData) SetInstanceFamily(v string) *RecommendationDetailData { + s.InstanceFamily = &v + return s +} + +// SetLatestUsageTimestamp sets the LatestUsageTimestamp field's value. +func (s *RecommendationDetailData) SetLatestUsageTimestamp(v string) *RecommendationDetailData { + s.LatestUsageTimestamp = &v + return s +} + +// SetLookbackPeriodInDays sets the LookbackPeriodInDays field's value. +func (s *RecommendationDetailData) SetLookbackPeriodInDays(v string) *RecommendationDetailData { + s.LookbackPeriodInDays = &v + return s +} + +// SetMetricsOverLookbackPeriod sets the MetricsOverLookbackPeriod field's value. +func (s *RecommendationDetailData) SetMetricsOverLookbackPeriod(v []*RecommendationDetailHourlyMetrics) *RecommendationDetailData { + s.MetricsOverLookbackPeriod = v + return s +} + +// SetOfferingId sets the OfferingId field's value. +func (s *RecommendationDetailData) SetOfferingId(v string) *RecommendationDetailData { + s.OfferingId = &v + return s +} + +// SetPaymentOption sets the PaymentOption field's value. +func (s *RecommendationDetailData) SetPaymentOption(v string) *RecommendationDetailData { + s.PaymentOption = &v + return s +} + +// SetRegion sets the Region field's value. +func (s *RecommendationDetailData) SetRegion(v string) *RecommendationDetailData { + s.Region = &v + return s +} + +// SetSavingsPlansType sets the SavingsPlansType field's value. +func (s *RecommendationDetailData) SetSavingsPlansType(v string) *RecommendationDetailData { + s.SavingsPlansType = &v + return s +} + +// SetTermInYears sets the TermInYears field's value. +func (s *RecommendationDetailData) SetTermInYears(v string) *RecommendationDetailData { + s.TermInYears = &v + return s +} + +// SetUpfrontCost sets the UpfrontCost field's value. +func (s *RecommendationDetailData) SetUpfrontCost(v string) *RecommendationDetailData { + s.UpfrontCost = &v + return s +} + +// Contains the hourly metrics for the given recommendation over the lookback +// period. +type RecommendationDetailHourlyMetrics struct { + _ struct{} `type:"structure"` + + // The current amount of Savings Plans eligible usage that the Savings Plan + // covered. + CurrentCoverage *string `type:"string"` + + // The estimated coverage amount based on the recommended Savings Plan. + EstimatedCoverage *string `type:"string"` + + // The estimated utilization for the recommended Savings Plan. + EstimatedNewCommitmentUtilization *string `type:"string"` + + // The remaining On-Demand cost estimated to not be covered by the recommended + // Savings Plan, over the length of the lookback period. + EstimatedOnDemandCost *string `type:"string"` + + // The period of time that you want the usage and costs for. + StartTime *string `min:"20" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationDetailHourlyMetrics) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationDetailHourlyMetrics) GoString() string { + return s.String() +} + +// SetCurrentCoverage sets the CurrentCoverage field's value. +func (s *RecommendationDetailHourlyMetrics) SetCurrentCoverage(v string) *RecommendationDetailHourlyMetrics { + s.CurrentCoverage = &v + return s +} + +// SetEstimatedCoverage sets the EstimatedCoverage field's value. +func (s *RecommendationDetailHourlyMetrics) SetEstimatedCoverage(v string) *RecommendationDetailHourlyMetrics { + s.EstimatedCoverage = &v + return s +} + +// SetEstimatedNewCommitmentUtilization sets the EstimatedNewCommitmentUtilization field's value. +func (s *RecommendationDetailHourlyMetrics) SetEstimatedNewCommitmentUtilization(v string) *RecommendationDetailHourlyMetrics { + s.EstimatedNewCommitmentUtilization = &v + return s +} + +// SetEstimatedOnDemandCost sets the EstimatedOnDemandCost field's value. +func (s *RecommendationDetailHourlyMetrics) SetEstimatedOnDemandCost(v string) *RecommendationDetailHourlyMetrics { + s.EstimatedOnDemandCost = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *RecommendationDetailHourlyMetrics) SetStartTime(v string) *RecommendationDetailHourlyMetrics { + s.StartTime = &v + return s +} + // Details about the Amazon Redshift instances that Amazon Web Services recommends // that you purchase. type RedshiftInstanceDetails struct { @@ -14233,6 +14807,9 @@ type SavingsPlansPurchaseRecommendationDetail struct { // configuration that's based on the usage during the lookback period. HourlyCommitmentToPurchase *string `type:"string"` + // Contains detailed information about a specific Savings Plan recommendation. + RecommendationDetailId *string `min:"36" type:"string"` + // Details for your recommended Savings Plans. SavingsPlansDetails *SavingsPlansDetails `type:"structure"` @@ -14343,6 +14920,12 @@ func (s *SavingsPlansPurchaseRecommendationDetail) SetHourlyCommitmentToPurchase return s } +// SetRecommendationDetailId sets the RecommendationDetailId field's value. +func (s *SavingsPlansPurchaseRecommendationDetail) SetRecommendationDetailId(v string) *SavingsPlansPurchaseRecommendationDetail { + s.RecommendationDetailId = &v + return s +} + // SetSavingsPlansDetails sets the SavingsPlansDetails field's value. func (s *SavingsPlansPurchaseRecommendationDetail) SetSavingsPlansDetails(v *SavingsPlansDetails) *SavingsPlansPurchaseRecommendationDetail { s.SavingsPlansDetails = v @@ -15975,15 +16558,22 @@ type UpdateAnomalySubscriptionInput struct { // This field has been deprecated. To update a threshold, use ThresholdExpression. // Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression. // + // You can specify either Threshold or ThresholdExpression, but not both. + // // Deprecated: Threshold has been deprecated in favor of ThresholdExpression Threshold *float64 `deprecated:"true" type:"double"` // The update to the Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object used to specify the anomalies that you want to generate alerts for. // This supports dimensions and nested expressions. The supported dimensions - // are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE. The - // supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL - // is required. Values must be numbers between 0 and 10,000,000,000. + // are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding + // to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see + // Impact (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) + // for more details). The supported nested expression types are AND and OR. + // The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers + // between 0 and 10,000,000,000 in string format. + // + // You can specify either Threshold or ThresholdExpression, but not both. // // The following are examples of valid ThresholdExpressions: // diff --git a/service/costexplorer/costexploreriface/interface.go b/service/costexplorer/costexploreriface/interface.go index fa4b53f4b66..21214b2ef6f 100644 --- a/service/costexplorer/costexploreriface/interface.go +++ b/service/costexplorer/costexploreriface/interface.go @@ -136,6 +136,10 @@ type CostExplorerAPI interface { GetRightsizingRecommendationWithContext(aws.Context, *costexplorer.GetRightsizingRecommendationInput, ...request.Option) (*costexplorer.GetRightsizingRecommendationOutput, error) GetRightsizingRecommendationRequest(*costexplorer.GetRightsizingRecommendationInput) (*request.Request, *costexplorer.GetRightsizingRecommendationOutput) + GetSavingsPlanPurchaseRecommendationDetails(*costexplorer.GetSavingsPlanPurchaseRecommendationDetailsInput) (*costexplorer.GetSavingsPlanPurchaseRecommendationDetailsOutput, error) + GetSavingsPlanPurchaseRecommendationDetailsWithContext(aws.Context, *costexplorer.GetSavingsPlanPurchaseRecommendationDetailsInput, ...request.Option) (*costexplorer.GetSavingsPlanPurchaseRecommendationDetailsOutput, error) + GetSavingsPlanPurchaseRecommendationDetailsRequest(*costexplorer.GetSavingsPlanPurchaseRecommendationDetailsInput) (*request.Request, *costexplorer.GetSavingsPlanPurchaseRecommendationDetailsOutput) + GetSavingsPlansCoverage(*costexplorer.GetSavingsPlansCoverageInput) (*costexplorer.GetSavingsPlansCoverageOutput, error) GetSavingsPlansCoverageWithContext(aws.Context, *costexplorer.GetSavingsPlansCoverageInput, ...request.Option) (*costexplorer.GetSavingsPlansCoverageOutput, error) GetSavingsPlansCoverageRequest(*costexplorer.GetSavingsPlansCoverageInput) (*request.Request, *costexplorer.GetSavingsPlansCoverageOutput) diff --git a/service/ec2/api.go b/service/ec2/api.go index a075daf63af..7180f5b5892 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -190067,6 +190067,9 @@ const ( // SpotInstanceStateFailed is a SpotInstanceState enum value SpotInstanceStateFailed = "failed" + + // SpotInstanceStateDisabled is a SpotInstanceState enum value + SpotInstanceStateDisabled = "disabled" ) // SpotInstanceState_Values returns all elements of the SpotInstanceState enum @@ -190077,6 +190080,7 @@ func SpotInstanceState_Values() []string { SpotInstanceStateClosed, SpotInstanceStateCancelled, SpotInstanceStateFailed, + SpotInstanceStateDisabled, } } diff --git a/service/glue/api.go b/service/glue/api.go index 921bd192393..ff259a66f61 100644 --- a/service/glue/api.go +++ b/service/glue/api.go @@ -25849,6 +25849,9 @@ type CodeGenConfigurationNode struct { // Specifies a target that uses Postgres SQL. PostgreSQLCatalogTarget *PostgreSQLCatalogTarget `type:"structure"` + // Specifies a Glue DataBrew recipe node. + Recipe *Recipe `type:"structure"` + // Specifies an Amazon Redshift data store. RedshiftSource *RedshiftSource `type:"structure"` @@ -26152,6 +26155,11 @@ func (s *CodeGenConfigurationNode) Validate() error { invalidParams.AddNested("PostgreSQLCatalogTarget", err.(request.ErrInvalidParams)) } } + if s.Recipe != nil { + if err := s.Recipe.Validate(); err != nil { + invalidParams.AddNested("Recipe", err.(request.ErrInvalidParams)) + } + } if s.RedshiftSource != nil { if err := s.RedshiftSource.Validate(); err != nil { invalidParams.AddNested("RedshiftSource", err.(request.ErrInvalidParams)) @@ -26528,6 +26536,12 @@ func (s *CodeGenConfigurationNode) SetPostgreSQLCatalogTarget(v *PostgreSQLCatal return s } +// SetRecipe sets the Recipe field's value. +func (s *CodeGenConfigurationNode) SetRecipe(v *Recipe) *CodeGenConfigurationNode { + s.Recipe = v + return s +} + // SetRedshiftSource sets the RedshiftSource field's value. func (s *CodeGenConfigurationNode) SetRedshiftSource(v *RedshiftSource) *CodeGenConfigurationNode { s.RedshiftSource = v @@ -58932,6 +58946,153 @@ func (s *QuerySchemaVersionMetadataOutput) SetSchemaVersionId(v string) *QuerySc return s } +// A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs. +type Recipe struct { + _ struct{} `type:"structure"` + + // The nodes that are inputs to the recipe node, identified by id. + // + // Inputs is a required field + Inputs []*string `min:"1" type:"list" required:"true"` + + // The name of the Glue Studio node. + // + // Name is a required field + Name *string `type:"string" required:"true"` + + // A reference to the DataBrew recipe used by the node. + // + // RecipeReference is a required field + RecipeReference *RecipeReference `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recipe) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recipe) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Recipe) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Recipe"} + if s.Inputs == nil { + invalidParams.Add(request.NewErrParamRequired("Inputs")) + } + if s.Inputs != nil && len(s.Inputs) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Inputs", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.RecipeReference == nil { + invalidParams.Add(request.NewErrParamRequired("RecipeReference")) + } + if s.RecipeReference != nil { + if err := s.RecipeReference.Validate(); err != nil { + invalidParams.AddNested("RecipeReference", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInputs sets the Inputs field's value. +func (s *Recipe) SetInputs(v []*string) *Recipe { + s.Inputs = v + return s +} + +// SetName sets the Name field's value. +func (s *Recipe) SetName(v string) *Recipe { + s.Name = &v + return s +} + +// SetRecipeReference sets the RecipeReference field's value. +func (s *Recipe) SetRecipeReference(v *RecipeReference) *Recipe { + s.RecipeReference = v + return s +} + +// A reference to a Glue DataBrew recipe. +type RecipeReference struct { + _ struct{} `type:"structure"` + + // The ARN of the DataBrew recipe. + // + // RecipeArn is a required field + RecipeArn *string `type:"string" required:"true"` + + // The RecipeVersion of the DataBrew recipe. + // + // RecipeVersion is a required field + RecipeVersion *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecipeReference) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecipeReference) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RecipeReference) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RecipeReference"} + if s.RecipeArn == nil { + invalidParams.Add(request.NewErrParamRequired("RecipeArn")) + } + if s.RecipeVersion == nil { + invalidParams.Add(request.NewErrParamRequired("RecipeVersion")) + } + if s.RecipeVersion != nil && len(*s.RecipeVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RecipeVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRecipeArn sets the RecipeArn field's value. +func (s *RecipeReference) SetRecipeArn(v string) *RecipeReference { + s.RecipeArn = &v + return s +} + +// SetRecipeVersion sets the RecipeVersion field's value. +func (s *RecipeReference) SetRecipeVersion(v string) *RecipeReference { + s.RecipeVersion = &v + return s +} + // When crawling an Amazon S3 data source after the first crawl is complete, // specifies whether to crawl the entire dataset again or to crawl only folders // that were added since the last crawler run. For more information, see Incremental diff --git a/service/quicksight/api.go b/service/quicksight/api.go index 381f3942c8d..fbb4dc346bb 100644 --- a/service/quicksight/api.go +++ b/service/quicksight/api.go @@ -2501,6 +2501,12 @@ func (c *QuickSight) DeleteAccountCustomizationRequest(input *DeleteAccountCusto // - ThrottlingException // Access is throttled. // +// - LimitExceededException +// A limit is exceeded. +// +// - PreconditionNotMetException +// One or more preconditions aren't met. +// // - InternalFailureException // An internal failure occurred. // @@ -5900,6 +5906,218 @@ func (c *QuickSight) DescribeDashboardPermissionsWithContext(ctx aws.Context, in return out, req.Send() } +const opDescribeDashboardSnapshotJob = "DescribeDashboardSnapshotJob" + +// DescribeDashboardSnapshotJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDashboardSnapshotJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeDashboardSnapshotJob for more information on using the DescribeDashboardSnapshotJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeDashboardSnapshotJobRequest method. +// req, resp := client.DescribeDashboardSnapshotJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJob +func (c *QuickSight) DescribeDashboardSnapshotJobRequest(input *DescribeDashboardSnapshotJobInput) (req *request.Request, output *DescribeDashboardSnapshotJobOutput) { + op := &request.Operation{ + Name: opDescribeDashboardSnapshotJob, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}", + } + + if input == nil { + input = &DescribeDashboardSnapshotJobInput{} + } + + output = &DescribeDashboardSnapshotJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDashboardSnapshotJob API operation for Amazon QuickSight. +// +// Describes an existing snapshot job. +// +// Poll job descriptions after a job starts to know the status of the job. For +// information on available status codes, see JobStatus. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation DescribeDashboardSnapshotJob for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// credentials. +// +// - ResourceNotFoundException +// One or more resources can't be found. +// +// - ThrottlingException +// Access is throttled. +// +// - UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// - InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJob +func (c *QuickSight) DescribeDashboardSnapshotJob(input *DescribeDashboardSnapshotJobInput) (*DescribeDashboardSnapshotJobOutput, error) { + req, out := c.DescribeDashboardSnapshotJobRequest(input) + return out, req.Send() +} + +// DescribeDashboardSnapshotJobWithContext is the same as DescribeDashboardSnapshotJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDashboardSnapshotJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) DescribeDashboardSnapshotJobWithContext(ctx aws.Context, input *DescribeDashboardSnapshotJobInput, opts ...request.Option) (*DescribeDashboardSnapshotJobOutput, error) { + req, out := c.DescribeDashboardSnapshotJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDashboardSnapshotJobResult = "DescribeDashboardSnapshotJobResult" + +// DescribeDashboardSnapshotJobResultRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDashboardSnapshotJobResult operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeDashboardSnapshotJobResult for more information on using the DescribeDashboardSnapshotJobResult +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeDashboardSnapshotJobResultRequest method. +// req, resp := client.DescribeDashboardSnapshotJobResultRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResult +func (c *QuickSight) DescribeDashboardSnapshotJobResultRequest(input *DescribeDashboardSnapshotJobResultInput) (req *request.Request, output *DescribeDashboardSnapshotJobResultOutput) { + op := &request.Operation{ + Name: opDescribeDashboardSnapshotJobResult, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result", + } + + if input == nil { + input = &DescribeDashboardSnapshotJobResultInput{} + } + + output = &DescribeDashboardSnapshotJobResultOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDashboardSnapshotJobResult API operation for Amazon QuickSight. +// +// Describes the result of an existing snapshot job that has finished running. +// +// A finished snapshot job will return a COMPLETED or FAILED status when you +// poll the job with a DescribeDashboardSnapshotJob API call. +// +// If the job has not finished running, this operation returns a message that +// says Dashboard Snapshot Job with id