A list of actions for the access permissions.
", + "smithy.api#documentation": "A list of actions for the access permissions. Any strings that can be used as an action\n in an IAM policy can be used in the list of actions to check.
", "smithy.api#length": { "max": 100 }, @@ -2529,7 +2529,7 @@ "type": { "target": "com.amazonaws.accessanalyzer#Type", "traits": { - "smithy.api#documentation": "The type of analyzer to create. Only ACCOUNT, ORGANIZATION,\n ACCOUNT_UNUSED_ACCESS, and ORGANIZTAION_UNUSED_ACCESS\n analyzers are supported. You can create only one analyzer per account per Region. You can\n create up to 5 analyzers per organization per Region.
The type of analyzer to create. Only ACCOUNT, ORGANIZATION,\n ACCOUNT_UNUSED_ACCESS, and ORGANIZATION_UNUSED_ACCESS\n analyzers are supported. You can create only one analyzer per account per Region. You can\n create up to 5 analyzers per organization per Region.
Retrieves information about the specified finding.
", + "smithy.api#documentation": "Retrieves information about the specified finding. GetFinding and GetFindingV2 both use\n access-analyzer:GetFinding in the Action element of an IAM\n policy statement. You must have permission to perform the\n access-analyzer:GetFinding action.
Retrieves information about the specified finding.
", + "smithy.api#documentation": "Retrieves information about the specified finding. GetFinding and GetFindingV2 both use\n access-analyzer:GetFinding in the Action element of an IAM\n policy statement. You must have permission to perform the\n access-analyzer:GetFinding action.
Retrieves a list of resources of the specified type that have been analyzed by the\n specified analyzer..
", + "smithy.api#documentation": "Retrieves a list of resources of the specified type that have been analyzed by the\n specified external access analyzer. This action is not supported for unused access\n analyzers.
", "smithy.api#http": { "uri": "/analyzed-resource", "method": "POST", @@ -4970,7 +4970,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a list of findings generated by the specified analyzer.
\nTo learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
", + "smithy.api#documentation": "Retrieves a list of findings generated by the specified analyzer. ListFindings and\n ListFindingsV2 both use access-analyzer:ListFindings in the\n Action element of an IAM policy statement. You must have permission to\n perform the access-analyzer:ListFindings action.
To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
", "smithy.api#http": { "uri": "/finding", "method": "POST", @@ -5071,7 +5071,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a list of findings generated by the specified analyzer.
\nTo learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
", + "smithy.api#documentation": "Retrieves a list of findings generated by the specified analyzer. ListFindings and\n ListFindingsV2 both use access-analyzer:ListFindings in the\n Action element of an IAM policy statement. You must have permission to\n perform the access-analyzer:ListFindings action.
To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
", "smithy.api#http": { "uri": "/findingv2", "method": "POST", @@ -5970,7 +5970,7 @@ } }, "traits": { - "smithy.api#documentation": "Proposed access control configuration for an Amazon S3 directory bucket. You can propose a\n configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you\n own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3\n directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the\n existing policy attached to the directory bucket. If the access preview is for a new\n resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an\n directory bucket without a policy. To propose deletion of an existing bucket policy, you\n can specify an empty string. For more information about bucket policy limits, see Example bucket policies.
" + "smithy.api#documentation": "Proposed access control configuration for an Amazon S3 directory bucket. You can propose a\n configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you\n own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3\n directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the\n existing policy attached to the directory bucket. If the access preview is for a new\n resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an\n directory bucket without a policy. To propose deletion of an existing bucket policy, you\n can specify an empty string. For more information about Amazon S3 directory bucket policies, see\n Example directory bucket policies for S3 Express One Zone.
" } }, "com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketPolicy": { diff --git a/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json b/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json index 1fa12787d6e..718c4eb85f0 100644 --- a/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json +++ b/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json @@ -9144,7 +9144,7 @@ "target": "com.amazonaws.apigateway#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
" + "smithy.api#documentation": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
" } }, "throttlingBurstLimit": { diff --git a/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json b/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json index 2a6287f2eb3..76fa8762ef7 100644 --- a/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json +++ b/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json @@ -337,7 +337,7 @@ "name": "appconfig" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly\n deploy application configurations. AppConfig supports controlled deployments to\n applications of any size and includes built-in validation checks and monitoring. You can\n use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers,\n mobile applications, or IoT devices.
\nTo prevent errors when deploying application configurations, especially for production\n systems where a simple typo could cause an unexpected outage, AppConfig includes\n validators. A validator provides a syntactic or semantic check to ensure that the\n configuration you want to deploy works as intended. To validate your application\n configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against\n the configuration. The configuration deployment or update can only proceed when the\n configuration data is valid.
\nDuring a configuration deployment, AppConfig monitors the application to\n ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can\n configure a deployment strategy for each application or environment that includes\n deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error\n monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back\n to the previous version.
\nAppConfig supports multiple use cases. Here are some examples:
\n\n Feature flags: Use AppConfig to turn on\n new features that require a timely deployment, such as a product launch or\n announcement.
\n\n Application tuning: Use AppConfig to\n carefully introduce changes to your application that can only be tested with\n production traffic.
\n\n Allow list: Use AppConfig to allow\n premium subscribers to access paid content.
\n\n Operational issues: Use AppConfig to\n reduce stress on your application when a dependency or other external factor impacts\n the system.
\nThis reference is intended to be used with the AppConfig User\n Guide.
", + "smithy.api#documentation": "AppConfig feature flags and dynamic configurations help software builders\n quickly and securely adjust application behavior in production environments without full\n code deployments. AppConfig speeds up software release frequency, improves\n application resiliency, and helps you address emergent issues more quickly. With feature\n flags, you can gradually release new capabilities to users and measure the impact of those\n changes before fully deploying the new capabilities to all users. With operational flags\n and dynamic configurations, you can update block lists, allow lists, throttling limits,\n logging verbosity, and perform other operational tuning to quickly respond to issues in\n production environments.
\nAppConfig is a capability of Amazon Web Services Systems Manager.
\nDespite the fact that application configuration content can vary greatly from\n application to application, AppConfig supports the following use cases, which\n cover a broad spectrum of customer needs:
\n\n Feature flags and toggles - Safely release new\n capabilities to your customers in a controlled environment. Instantly roll back\n changes if you experience a problem.
\n\n Application tuning - Carefully introduce\n application changes while testing the impact of those changes with users in\n production environments.
\n\n Allow list or block list - Control access to\n premium features or instantly block specific users without deploying new code.\n
\n\n Centralized configuration storage - Keep your\n configuration data organized and consistent across all of your workloads. You can use\n AppConfig to deploy configuration data stored in the AppConfig\n hosted configuration store, Secrets Manager, Systems Manager, Parameter\n Store, or Amazon S3.
\n\n How AppConfig works\n
\nThis section provides a high-level description of how AppConfig works and how\n you get started.
\nBefore you start creating AppConfig artifacts, we recommend you\n identify configuration data in your code that you want to dynamically manage using\n AppConfig. Good examples include feature flags or toggles, allow and\n block lists, logging verbosity, service limits, and throttling rules, to name a\n few.
\nIf your configuration data already exists in the cloud, you can take advantage\n of AppConfig validation, deployment, and extension features to further\n streamline configuration data management.
\nTo create a namespace, you create an AppConfig artifact called an\n application. An application is simply an organizational construct like a\n folder.
\nFor each AppConfig application, you define one or more environments.\n An environment is a logical grouping of targets, such as applications in a\n Beta or Production environment, Lambda functions,\n or containers. You can also define environments for application subcomponents,\n such as the Web, Mobile, and\n Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors\n alarms during a configuration deployment. If an alarm is triggered, the system\n rolls back the configuration.
\nA configuration profile includes, among other things, a URI that enables\n AppConfig to locate your configuration data in its stored location\n and a profile type. AppConfig supports two configuration profile types:\n feature flags and freeform configurations. Feature flag configuration profiles\n store their data in the AppConfig hosted configuration store and the URI\n is simply hosted. For freeform configuration profiles, you can store\n your data in the AppConfig hosted configuration store or any Amazon Web Services\n service that integrates with AppConfig, as described in Creating\n a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your\n configuration data is syntactically and semantically correct. AppConfig\n performs a check using the validators when you start a deployment. If any errors\n are detected, the deployment rolls back to the previous configuration data.
\nWhen you create a new deployment, you specify the following:
\nAn application ID
\nA configuration profile ID
\nA configuration version
\nAn environment ID where you want to deploy the configuration data
\nA deployment strategy ID that defines how fast you want the changes to\n take effect
\nWhen you call the StartDeployment API action, AppConfig performs the following\n tasks:
\nRetrieves the configuration data from the underlying data store by using\n the location URI in the configuration profile.
\nVerifies the configuration data is syntactically and semantically correct\n by using the validators you specified when you created your configuration\n profile.
\nCaches a copy of the data so it is ready to be retrieved by your\n application. This cached copy is called the deployed\n data.
\nYou can configure AppConfig Agent as a local host and have the agent\n poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data\n locally. To retrieve the data, your application makes an HTTP call to the\n localhost server. AppConfig Agent supports several use cases, as\n described in Simplified\n retrieval methods in the the AppConfig User\n Guide.
\nIf AppConfig Agent isn't supported for your use case, you can\n configure your application to poll AppConfig for configuration updates\n by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
\nThis reference is intended to be used with the AppConfig User\n Guide.
", "smithy.api#title": "Amazon AppConfig", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1574,13 +1574,13 @@ "KmsKeyArn": { "target": "com.amazonaws.appconfig#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name of the Key Management Service key to encrypt new configuration data\n versions in the AppConfig hosted configuration store. This\n attribute is only used for hosted configuration types. To encrypt data managed\n in other configuration stores, see the documentation for how to specify an KMS key for that particular service.
The Amazon Resource Name of the Key Management Service key to encrypt new configuration\n data versions in the AppConfig hosted configuration store. This attribute is only\n used for hosted configuration types. To encrypt data managed in other\n configuration stores, see the documentation for how to specify an KMS key\n for that particular service.
The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
" + "smithy.api#documentation": "The Key Management Service key identifier (key ID, key alias, or key ARN) provided when\n the resource was created or updated.
" } } } @@ -1849,7 +1849,7 @@ "KmsKeyIdentifier": { "target": "com.amazonaws.appconfig#KmsKeyIdentifier", "traits": { - "smithy.api#documentation": "The identifier for an Key Management Service key to encrypt new configuration\n data versions in the AppConfig hosted configuration store. This attribute is only\n used for hosted configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias.\n To encrypt data managed in other configuration stores, see the documentation for how to\n specify an KMS key for that particular service.
The identifier for an Key Management Service key to encrypt new configuration data\n versions in the AppConfig hosted configuration store. This attribute is only used\n for hosted configuration types. The identifier can be an KMS\n key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data\n managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.
Creates an AppConfig extension. An extension augments your ability to inject\n logic or behavior at different points during the AppConfig workflow of creating\n or deploying a configuration.
\nYou can create your own extensions or use the Amazon Web Services authored extensions provided by\n AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing\n defined in the extension. If you plan to create custom versions of the Amazon Web Services\n authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in\n the Uri field for the new extension version.
For a custom EventBridge notification extension, enter the ARN of the EventBridge\n default events in the Uri field.
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS\n topic in the Uri field.
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS\n message queue in the Uri field.
For more information about extensions, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#documentation": "Creates an AppConfig extension. An extension augments your ability to inject\n logic or behavior at different points during the AppConfig workflow of creating\n or deploying a configuration.
\nYou can create your own extensions or use the Amazon Web Services authored extensions provided by\n AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing\n defined in the extension. If you plan to create custom versions of the Amazon Web Services\n authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in\n the Uri field for the new extension version.
For a custom EventBridge notification extension, enter the ARN of the EventBridge\n default events in the Uri field.
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS\n topic in the Uri field.
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS\n message queue in the Uri field.
For more information about extensions, see Extending\n workflows in the AppConfig User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/extensions", @@ -2109,7 +2109,7 @@ } ], "traits": { - "smithy.api#documentation": "When you create an extension or configure an Amazon Web Services authored extension, you\n associate the extension with an AppConfig application, environment, or\n configuration profile. For example, you can choose to run the AppConfig\n deployment events to Amazon SNS\n Amazon Web Services authored extension and receive notifications on an Amazon SNS\n topic anytime a configuration deployment is started for a specific application. Defining\n which extension to associate with an AppConfig resource is called an\n extension association. An extension association is a specified\n relationship between an extension and an AppConfig resource, such as an\n application or a configuration profile. For more information about extensions and\n associations, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
When you create an extension or configure an Amazon Web Services authored extension, you\n associate the extension with an AppConfig application, environment, or\n configuration profile. For example, you can choose to run the AppConfig\n deployment events to Amazon SNS\n Amazon Web Services authored extension and receive notifications on an Amazon SNS\n topic anytime a configuration deployment is started for a specific application. Defining\n which extension to associate with an AppConfig resource is called an\n extension association. An extension association is a specified\n relationship between an extension and an AppConfig resource, such as an\n application or a configuration profile. For more information about extensions and\n associations, see Extending\n workflows in the AppConfig User Guide.
The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
" + "smithy.api#documentation": "The Key Management Service key identifier (key ID, key alias, or key ARN) provided when\n the resource was created or updated.
" } }, "VersionLabel": { @@ -3193,6 +3193,27 @@ } } }, + "com.amazonaws.appconfig#DynamicParameterKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([^#\\n]{1,96})#([^\\/#\\n]{1,64})$" + } + }, + "com.amazonaws.appconfig#DynamicParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appconfig#DynamicParameterKey" + }, + "value": { + "target": "com.amazonaws.appconfig#StringWithLengthBetween1And2048" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.appconfig#Environment": { "type": "structure", "members": { @@ -3958,7 +3979,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an AppConfig extension association. For more\n information about extensions and associations, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#documentation": "Returns information about an AppConfig extension association. For more\n information about extensions and associations, see Extending\n workflows in the AppConfig User Guide.
", "smithy.api#http": { "method": "GET", "uri": "/extensionassociations/{ExtensionAssociationId}", @@ -4754,7 +4775,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all AppConfig extension associations in the account. For more\n information about extensions and associations, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#documentation": "Lists all AppConfig extension associations in the account. For more\n information about extensions and associations, see Extending\n workflows in the AppConfig User Guide.
", "smithy.api#http": { "method": "GET", "uri": "/extensionassociations", @@ -4829,7 +4850,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all custom and Amazon Web Services authored AppConfig extensions in the\n account. For more information about extensions, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#documentation": "Lists all custom and Amazon Web Services authored AppConfig extensions in the\n account. For more information about extensions, see Extending\n workflows in the AppConfig User Guide.
", "smithy.api#http": { "method": "GET", "uri": "/extensions", @@ -5123,10 +5144,17 @@ "smithy.api#default": false, "smithy.api#documentation": "A parameter value must be specified in the extension association.
" } + }, + "Dynamic": { + "target": "com.amazonaws.appconfig#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether this parameter's value can be supplied at the extension's action point\n instead of during extension association. Dynamic parameters can't be marked\n Required.
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered\n in an extension when invoked. Parameter values are specified in an extension association.\n For more information about extensions, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
" + "smithy.api#documentation": "A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered\n in an extension when invoked. Parameter values are specified in an extension association.\n For more information about extensions, see Extending\n workflows in the AppConfig User Guide.
" } }, "com.amazonaws.appconfig#ParameterMap": { @@ -5140,7 +5168,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 10 } } }, @@ -5155,7 +5183,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 5 + "max": 10 } } }, @@ -5360,6 +5388,12 @@ "traits": { "smithy.api#documentation": "The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
" } + }, + "DynamicExtensionParameters": { + "target": "com.amazonaws.appconfig#DynamicParameterMap", + "traits": { + "smithy.api#documentation": "A map of dynamic extension parameter names to values to pass to associated extensions\n with PRE_START_DEPLOYMENT actions.
The identifier for a Key Management Service key to encrypt new configuration\n data versions in the AppConfig hosted configuration store. This attribute is only\n used for hosted configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias.\n To encrypt data managed in other configuration stores, see the documentation for how to\n specify an KMS key for that particular service.
The identifier for a Key Management Service key to encrypt new configuration data\n versions in the AppConfig hosted configuration store. This attribute is only used\n for hosted configuration types. The identifier can be an KMS\n key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data\n managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.
Updates an AppConfig extension. For more information about extensions, see\n Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#documentation": "Updates an AppConfig extension. For more information about extensions, see\n Extending\n workflows in the AppConfig User Guide.
", "smithy.api#http": { "method": "PATCH", "uri": "/extensions/{ExtensionIdentifier}", @@ -6093,7 +6127,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an association. For more information about extensions and associations, see\n Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#documentation": "Updates an association. For more information about extensions and associations, see\n Extending\n workflows in the AppConfig User Guide.
", "smithy.api#http": { "method": "PATCH", "uri": "/extensionassociations/{ExtensionAssociationId}", diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json index f9a0e81b737..8786398bda5 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json @@ -2800,7 +2800,7 @@ } ], "traits": { - "smithy.api#documentation": "\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nIf you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
[Price protection] The price protection threshold for Spot Instances, as a percentage\n higher than an identified Spot price. The identified Spot price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
\nTo turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be\n specified.
Default: 100\n
[Price protection] The price protection threshold for Spot Instances, as a percentage\n higher than an identified Spot price. The identified Spot price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
\nIf you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.
[Price protection] The price protection threshold for Spot Instances, as a percentage\n of an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
\nTo indicate no price protection threshold, specify a high value, such as\n 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, then SpotMaxPricePercentageOverLowestPrice is\n used and the value for that parameter defaults to 100.
[Price protection] The price protection threshold for Spot Instances, as a percentage\n of an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
\nIf you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.
One of the following policy types:
\n\n TargetTrackingScaling\n
\n StepScaling\n
\n SimpleScaling (default)
\n PredictiveScaling\n
For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "One of the following policy types:
\n\n TargetTrackingScaling\n
\n StepScaling\n
\n SimpleScaling (default)
\n PredictiveScaling\n
For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
" } }, "AdjustmentType": { @@ -9669,7 +9669,7 @@ "MinAdjustmentMagnitude": { "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", "traits": { - "smithy.api#documentation": "The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.
The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.
The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.
The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.
The tags that you apply to the job queue to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources\n in Batch User Guide.
" } + }, + "jobStateTimeLimitActions": { + "target": "com.amazonaws.batch#JobStateTimeLimitActions", + "traits": { + "smithy.api#documentation": "The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state\n longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
A short, human-readable string to provide more details for the current status of the\n job.
" + "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the job.
\n\n CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to\n service the job.
\n MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a\n maxVcpu setting that is smaller than the job requirements.
\n MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances\n that meet the job requirements.
\n MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the\n service role permissions.
The tags that are applied to the job queue. For more information, see Tagging your Batch resources in\n Batch User Guide.
" } + }, + "jobStateTimeLimitActions": { + "target": "com.amazonaws.batch#JobStateTimeLimitActions", + "traits": { + "smithy.api#documentation": "The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state\n longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
The reason to log for the action being taken.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.batch#JobStateTimeLimitActionsState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The state of the job needed to trigger the action. The only supported value is \"RUNNABLE\".
The approximate amount of time, in seconds, that must pass with the job in the specified state before the action\n is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.batch#JobStateTimeLimitActionsAction", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The action to take when a job is at the head of the job queue in the specified state for the specified period of\n time. The only supported value is \"CANCEL\", which will cancel the job.
Specifies an action that Batch will take after the job has remained at the head of the queue in the specified\n state for longer than the specified time.
" + } + }, + "com.amazonaws.batch#JobStateTimeLimitActions": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#JobStateTimeLimitAction" + } + }, + "com.amazonaws.batch#JobStateTimeLimitActionsAction": { + "type": "enum", + "members": { + "CANCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL" + } + } + } + }, + "com.amazonaws.batch#JobStateTimeLimitActionsState": { + "type": "enum", + "members": { + "RUNNABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNABLE" + } + } + } + }, "com.amazonaws.batch#JobStatus": { "type": "enum", "members": { @@ -7123,7 +7203,7 @@ "essential": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All tasks must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All jobs must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" } }, "image": { @@ -7283,7 +7363,7 @@ "essential": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All tasks must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All jobs must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" } }, "image": { @@ -7771,6 +7851,12 @@ "traits": { "smithy.api#documentation": "Details the set of compute environments mapped to a job queue and their order relative to\n each other. This is one of the parameters used by the job scheduler to determine which compute\n environment runs a given job. Compute environments must be in the VALID state\n before you can associate them with a job queue. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a\n single job queue.
\nThe set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state\n longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
The request is denied because of missing access permissions. Check your permissions and retry your request.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -18,54 +18,69 @@ "type": "structure", "members": { "actionGroupName": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupName" + "target": "com.amazonaws.bedrockagentruntime#ActionGroupName", + "traits": { + "smithy.api#documentation": "The name of the action group.
" + } }, "verb": { - "target": "com.amazonaws.bedrockagentruntime#Verb" + "target": "com.amazonaws.bedrockagentruntime#Verb", + "traits": { + "smithy.api#documentation": "The API method being used, based off the action group.
" + } }, "apiPath": { - "target": "com.amazonaws.bedrockagentruntime#ApiPath" + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API to call, based off the action group.
" + } }, "parameters": { - "target": "com.amazonaws.bedrockagentruntime#Parameters" + "target": "com.amazonaws.bedrockagentruntime#Parameters", + "traits": { + "smithy.api#documentation": "The parameters in the Lambda input event.
" + } }, "requestBody": { - "target": "com.amazonaws.bedrockagentruntime#RequestBody" + "target": "com.amazonaws.bedrockagentruntime#RequestBody", + "traits": { + "smithy.api#documentation": "The parameters in the request body for the Lambda input event.
" + } } }, "traits": { - "smithy.api#documentation": "input to lambda used in action group" + "smithy.api#documentation": "Contains information about the action group being invoked.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput": { "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupOutputString" + "target": "com.amazonaws.bedrockagentruntime#ActionGroupOutputString", + "traits": { + "smithy.api#documentation": "The JSON-formatted string returned by the API invoked by the action group.
" + } } }, "traits": { - "smithy.api#documentation": "output from lambda used in action group" + "smithy.api#documentation": "Contains the JSON-formatted string returned by the API invoked by the action group.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupName": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Name", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ActionGroupOutputString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#AgentAliasId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the agent alias.", "smithy.api#length": { "max": 10 }, @@ -75,7 +90,6 @@ "com.amazonaws.bedrockagentruntime#AgentId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the agent.", "smithy.api#length": { "max": 10 }, @@ -107,7 +121,7 @@ "name": "bedrock" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Bedrock Agent", + "smithy.api#documentation": "Contains APIs related to model invocation and querying of knowledge bases.
", "smithy.api#title": "Agents for Amazon Bedrock Runtime", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -778,7 +792,6 @@ "com.amazonaws.bedrockagentruntime#ApiPath": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group API path", "smithy.api#sensitive": {} } }, @@ -786,11 +799,14 @@ "type": "structure", "members": { "citations": { - "target": "com.amazonaws.bedrockagentruntime#Citations" + "target": "com.amazonaws.bedrockagentruntime#Citations", + "traits": { + "smithy.api#documentation": "A list of citations and related information for a part of an agent response.
" + } } }, "traits": { - "smithy.api#documentation": "Citations associated with final agent response" + "smithy.api#documentation": "Contains citations for a part of an agent response.
" } }, "com.amazonaws.bedrockagentruntime#BadGatewayException": { @@ -800,11 +816,14 @@ "target": "com.amazonaws.bedrockagentruntime#NonBlankString" }, "resourceName": { - "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + "target": "com.amazonaws.bedrockagentruntime#NonBlankString", + "traits": { + "smithy.api#documentation": "The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
" + } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource", + "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -812,7 +831,6 @@ "com.amazonaws.bedrockagentruntime#BedrockModelArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn of a Bedrock model.", "smithy.api#length": { "min": 20, "max": 1011 @@ -824,23 +842,26 @@ "type": "structure", "members": { "generatedResponsePart": { - "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart" + "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart", + "traits": { + "smithy.api#documentation": "Contains the generated response and metadata
" + } }, "retrievedReferences": { - "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences" + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", + "traits": { + "smithy.api#documentation": "Contains metadata about the sources cited for the generated response.
" + } } }, "traits": { - "smithy.api#documentation": "Citation associated with the agent response" + "smithy.api#documentation": "An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
" } }, "com.amazonaws.bedrockagentruntime#Citations": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Citation" - }, - "traits": { - "smithy.api#documentation": "List of citations" } }, "com.amazonaws.bedrockagentruntime#ConflictException": { @@ -851,7 +872,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when there is a conflict performing an operation", + "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -863,9 +884,6 @@ }, "value": { "target": "com.amazonaws.bedrockagentruntime#Parameters" - }, - "traits": { - "smithy.api#documentation": "Content type paramter map" } }, "com.amazonaws.bedrockagentruntime#CreationMode": { @@ -883,9 +901,6 @@ "smithy.api#enumValue": "OVERRIDDEN" } } - }, - "traits": { - "smithy.api#documentation": "indicates if agent uses default prompt or overriden prompt" } }, "com.amazonaws.bedrockagentruntime#DependencyFailedException": { @@ -895,11 +910,14 @@ "target": "com.amazonaws.bedrockagentruntime#NonBlankString" }, "resourceName": { - "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + "target": "com.amazonaws.bedrockagentruntime#NonBlankString", + "traits": { + "smithy.api#documentation": "The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
" + } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)", + "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
", "smithy.api#error": "client", "smithy.api#httpError": 424 } @@ -907,7 +925,6 @@ "com.amazonaws.bedrockagentruntime#FailureReasonString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Failed Reason String", "smithy.api#sensitive": {} } }, @@ -915,14 +932,20 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } }, "failureReason": { - "target": "com.amazonaws.bedrockagentruntime#FailureReasonString" + "target": "com.amazonaws.bedrockagentruntime#FailureReasonString", + "traits": { + "smithy.api#documentation": "The reason the interaction failed.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which is emitted when agent trace could not be generated", + "smithy.api#documentation": "Contains information about the failure of the interaction.
", "smithy.api#sensitive": {} } }, @@ -930,17 +953,19 @@ "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#FinalResponseString" + "target": "com.amazonaws.bedrockagentruntime#FinalResponseString", + "traits": { + "smithy.api#documentation": "The text in the response to the user.
" + } } }, "traits": { - "smithy.api#documentation": "Agent finish output" + "smithy.api#documentation": "Contains details about the response to the user.
" } }, "com.amazonaws.bedrockagentruntime#FinalResponseString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", "smithy.api#sensitive": {} } }, @@ -948,34 +973,52 @@ "type": "structure", "members": { "textResponsePart": { - "target": "com.amazonaws.bedrockagentruntime#TextResponsePart" + "target": "com.amazonaws.bedrockagentruntime#TextResponsePart", + "traits": { + "smithy.api#documentation": "Contains metadata about a textual part of the generated response that is accompanied by a citation.
" + } } }, "traits": { - "smithy.api#documentation": "Generate response part" + "smithy.api#documentation": "Contains metadata about a part of the generated response that is accompanied by a citation.
" } }, "com.amazonaws.bedrockagentruntime#InferenceConfiguration": { "type": "structure", "members": { "temperature": { - "target": "com.amazonaws.bedrockagentruntime#Temperature" + "target": "com.amazonaws.bedrockagentruntime#Temperature", + "traits": { + "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" + } }, "topP": { - "target": "com.amazonaws.bedrockagentruntime#TopP" + "target": "com.amazonaws.bedrockagentruntime#TopP", + "traits": { + "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens allowed in the generated response.
" + } }, "stopSequences": { - "target": "com.amazonaws.bedrockagentruntime#StopSequences" + "target": "com.amazonaws.bedrockagentruntime#StopSequences", + "traits": { + "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" + } } }, "traits": { - "smithy.api#documentation": "Configurations for controlling the inference response of an InvokeAgent API call" + "smithy.api#documentation": "Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
" } }, "com.amazonaws.bedrockagentruntime#InferenceResource": { @@ -989,7 +1032,6 @@ "com.amazonaws.bedrockagentruntime#InputText": { "type": "string", "traits": { - "smithy.api#documentation": "Model text input", "smithy.api#length": { "max": 25000000 }, @@ -1004,7 +1046,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown if there was an unexpected error during processing of request", + "smithy.api#documentation": "An internal server error occurred. Retry your request.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1013,20 +1055,32 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } }, "invocationType": { - "target": "com.amazonaws.bedrockagentruntime#InvocationType" + "target": "com.amazonaws.bedrockagentruntime#InvocationType", + "traits": { + "smithy.api#documentation": "Specifies whether the agent is invoking an action group or a knowledge base.
" + } }, "actionGroupInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput", + "traits": { + "smithy.api#documentation": "Contains information about the action group to be invoked.
" + } }, "knowledgeBaseLookupInput": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base to look up and the query to be made.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains input details for action group or knowledge base", + "smithy.api#documentation": "Contains information pertaining to the action group or knowledge base that is being invoked.
", "smithy.api#sensitive": {} } }, @@ -1051,9 +1105,6 @@ "smithy.api#enumValue": "FINISH" } } - }, - "traits": { - "smithy.api#documentation": "types of invocations" } }, "com.amazonaws.bedrockagentruntime#InvokeAgent": { @@ -1094,7 +1145,7 @@ } ], "traits": { - "smithy.api#documentation": "Invokes the specified Bedrock model to run inference using the input provided in the request body.", + "smithy.api#documentation": "Sends a prompt for the agent to process and respond to.
\nThe CLI doesn't support InvokeAgent.
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
Include attributes for the session or prompt in the sessionState object.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
Errors are also surfaced in the response.
\nContains parameters that specify various attributes of the session.
" } }, "agentId": { "target": "com.amazonaws.bedrockagentruntime#AgentId", "traits": { - "smithy.api#documentation": "Identifier for Agent", + "smithy.api#documentation": "The unique identifier of the agent to use.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1122,7 +1173,7 @@ "agentAliasId": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", "traits": { - "smithy.api#documentation": "Identifier for Agent Alias", + "smithy.api#documentation": "The alias of the agent to use.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1130,7 +1181,7 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "Identifier used for the current session", + "smithy.api#documentation": "The unique identifier of the session. Use the same value across requests to continue the same conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1138,25 +1189,24 @@ "endSession": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "End current session" + "smithy.api#documentation": "Specifies whether to end the session with the agent or not.
" } }, "enableTrace": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Enable agent trace events for improved debugging" + "smithy.api#documentation": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
" } }, "inputText": { "target": "com.amazonaws.bedrockagentruntime#InputText", "traits": { - "smithy.api#documentation": "Input data in the format specified in the Content-Type request header.", + "smithy.api#documentation": "The prompt text to send the agent.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "InvokeAgent Request", "smithy.api#input": {} } }, @@ -1166,7 +1216,7 @@ "completion": { "target": "com.amazonaws.bedrockagentruntime#ResponseStream", "traits": { - "smithy.api#documentation": "Inference response from the model in the format specified in the Content-Type response header.", + "smithy.api#documentation": "The agent's response to the user prompt.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1174,7 +1224,7 @@ "contentType": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { - "smithy.api#documentation": "streaming response mimetype of the model", + "smithy.api#documentation": "The MIME type of the input data in the request. The default value is application/json.
The unique identifier of the session with the agent.
", "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "InvokeAgent Response", "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#KmsKeyArn": { "type": "string", "traits": { - "smithy.api#documentation": "A KMS key ARN", "smithy.api#length": { "min": 1, "max": 2048 @@ -1207,7 +1255,6 @@ "com.amazonaws.bedrockagentruntime#KnowledgeBaseId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the KnowledgeBase", "smithy.api#length": { "max": 10 }, @@ -1218,20 +1265,25 @@ "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString", + "traits": { + "smithy.api#documentation": "The query made to the knowledge base.
" + } }, "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId" + "target": "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to look up.
" + } } }, "traits": { - "smithy.api#documentation": "Input to lambda used in action group" + "smithy.api#documentation": "Contains details about the knowledge base to look up and the query to be made.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", "smithy.api#sensitive": {} } }, @@ -1239,11 +1291,14 @@ "type": "structure", "members": { "retrievedReferences": { - "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences" + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", + "traits": { + "smithy.api#documentation": "Contains metadata about the sources cited for the generated response.
" + } } }, "traits": { - "smithy.api#documentation": "Input to lambda used in action group" + "smithy.api#documentation": "Contains details about the results from looking up the knowledge base.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery": { @@ -1252,7 +1307,7 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Knowledge base input query in text", + "smithy.api#documentation": "The text of the query made to the knowledge base.
", "smithy.api#length": { "max": 1000 }, @@ -1261,7 +1316,7 @@ } }, "traits": { - "smithy.api#documentation": "Knowledge base input query.", + "smithy.api#documentation": "Contains the query made to the knowledge base.
", "smithy.api#sensitive": {} } }, @@ -1271,12 +1326,13 @@ "vectorSearchConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration", "traits": { + "smithy.api#documentation": "Contains details about how the results from the vector search should be returned.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Search parameters for retrieving from knowledge base." + "smithy.api#documentation": "Contains details about how the results should be returned.
\nThis data type is used in the following API operations:
\nContains a chunk of text from a data source in the knowledge base.
", "smithy.api#required": {} } }, "location": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation" + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", + "traits": { + "smithy.api#documentation": "Contains information about the location of the data source.
" + } }, "score": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The relevance score of a result." + "smithy.api#documentation": "The level of relevance of the result to the query.
" } } }, "traits": { - "smithy.api#documentation": "Result item returned from a knowledge base retrieval." + "smithy.api#documentation": "Details about a result from querying the knowledge base.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResults": { @@ -1308,7 +1368,6 @@ "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResult" }, "traits": { - "smithy.api#documentation": "List of knowledge base retrieval results", "smithy.api#sensitive": {} } }, @@ -1318,21 +1377,26 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that is queried and the foundation model used for generation.
", "smithy.api#required": {} } }, "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { + "smithy.api#documentation": "The ARN of the foundation model used to generate a response.
", "smithy.api#required": {} } }, "retrievalConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for how to retrieve and return the knowledge base query.
" + } } }, "traits": { - "smithy.api#documentation": "Configurations for retrieval and generation for knowledge base." + "smithy.api#documentation": "Contains details about the resource being queried.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { @@ -1343,7 +1407,7 @@ "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": 5, - "smithy.api#documentation": "Top-K results to retrieve from knowledge base.", + "smithy.api#documentation": "The number of results to return.
\nThe numberOfResults field is currently unsupported for RetrieveAndGenerate. Don't include it in this field if you are sending a RetrieveAndGenerate request.
By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
Configurations for how to carry out the search.
" } }, "com.amazonaws.bedrockagentruntime#LambdaArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "ARN of a Lambda." - } + "type": "string" }, "com.amazonaws.bedrockagentruntime#MaximumLength": { "type": "integer", "traits": { - "smithy.api#documentation": "Maximum length of output", "smithy.api#range": { "min": 0, "max": 4096 @@ -1378,45 +1438,62 @@ } }, "com.amazonaws.bedrockagentruntime#MimeType": { - "type": "string", - "traits": { - "smithy.api#documentation": "Content type of the request" - } + "type": "string" }, "com.amazonaws.bedrockagentruntime#ModelInvocationInput": { "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } }, "text": { - "target": "com.amazonaws.bedrockagentruntime#PromptText" + "target": "com.amazonaws.bedrockagentruntime#PromptText", + "traits": { + "smithy.api#documentation": "The text that prompted the agent at this step.
" + } }, "type": { - "target": "com.amazonaws.bedrockagentruntime#PromptType" + "target": "com.amazonaws.bedrockagentruntime#PromptType", + "traits": { + "smithy.api#documentation": "The step in the agent sequence.
" + } }, "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration" + "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
" + } }, "overrideLambda": { - "target": "com.amazonaws.bedrockagentruntime#LambdaArn" + "target": "com.amazonaws.bedrockagentruntime#LambdaArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
" + } }, "promptCreationMode": { - "target": "com.amazonaws.bedrockagentruntime#CreationMode" + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
The input for the pre-processing step.
\nThe type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The unique identifier of the trace.
" + } }, "type": { - "target": "com.amazonaws.bedrockagentruntime#Type" + "target": "com.amazonaws.bedrockagentruntime#Type", + "traits": { + "smithy.api#documentation": "Specifies what kind of information the agent returns in the observation. The following values are possible.
\n\n ACTION_GROUP – The agent returns the result of an action group.
\n KNOWLEDGE_BASE – The agent returns information from a knowledge base.
\n FINISH – The agent returns a final response to the user with no follow-up.
\n ASK_USER – The agent asks the user a question.
\n REPROMPT – The agent prompts the user again for the same information.
Contains the JSON-formatted string returned by the API invoked by the action group.
" + } }, "knowledgeBaseLookupOutput": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput", + "traits": { + "smithy.api#documentation": "Contains details about the results from looking up the knowledge base.
" + } }, "finalResponse": { - "target": "com.amazonaws.bedrockagentruntime#FinalResponse" + "target": "com.amazonaws.bedrockagentruntime#FinalResponse", + "traits": { + "smithy.api#documentation": "Contains details about the response to the user.
" + } }, "repromptResponse": { - "target": "com.amazonaws.bedrockagentruntime#RepromptResponse" + "target": "com.amazonaws.bedrockagentruntime#RepromptResponse", + "traits": { + "smithy.api#documentation": "Contains details about the response to reprompt the input.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains output details for action group or knowledge base or final response", + "smithy.api#documentation": "Contains the result or output of an action group or knowledge base, or the response to the user.
", "smithy.api#sensitive": {} } }, @@ -1462,27 +1556,38 @@ "type": "union", "members": { "rationale": { - "target": "com.amazonaws.bedrockagentruntime#Rationale" + "target": "com.amazonaws.bedrockagentruntime#Rationale", + "traits": { + "smithy.api#documentation": "Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
" + } }, "invocationInput": { - "target": "com.amazonaws.bedrockagentruntime#InvocationInput" + "target": "com.amazonaws.bedrockagentruntime#InvocationInput", + "traits": { + "smithy.api#documentation": "Contains information pertaining to the action group or knowledge base that is being invoked.
" + } }, "observation": { - "target": "com.amazonaws.bedrockagentruntime#Observation" + "target": "com.amazonaws.bedrockagentruntime#Observation", + "traits": { + "smithy.api#documentation": "Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
" + } }, "modelInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "The input for the orchestration step.
\nThe type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#OutputString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Output String", "smithy.api#sensitive": {} } }, @@ -1492,39 +1597,35 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Name of parameter" + "smithy.api#documentation": "The name of the parameter.
" } }, "type": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of parameter" + "smithy.api#documentation": "The type of the parameter.
" } }, "value": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Value of parameter" + "smithy.api#documentation": "The value of the parameter.
" } } }, "traits": { - "smithy.api#documentation": "parameters included in action group invocation" + "smithy.api#documentation": "A parameter in the Lambda input event.
" } }, "com.amazonaws.bedrockagentruntime#Parameters": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Parameter" - }, - "traits": { - "smithy.api#documentation": "list of parameters included in action group invocation" } }, "com.amazonaws.bedrockagentruntime#PartBody": { "type": "blob", "traits": { - "smithy.api#documentation": "PartBody of the payload in bytes", "smithy.api#length": { "max": 1000000 }, @@ -1535,14 +1636,20 @@ "type": "structure", "members": { "bytes": { - "target": "com.amazonaws.bedrockagentruntime#PartBody" + "target": "com.amazonaws.bedrockagentruntime#PartBody", + "traits": { + "smithy.api#documentation": "A part of the agent response in bytes.
" + } }, "attribution": { - "target": "com.amazonaws.bedrockagentruntime#Attribution" + "target": "com.amazonaws.bedrockagentruntime#Attribution", + "traits": { + "smithy.api#documentation": "Contains citations for a part of an agent response.
" + } } }, "traits": { - "smithy.api#documentation": "Base 64 endoded byte response", + "smithy.api#documentation": "Contains a part of an agent response and citations for it.
", "smithy.api#sensitive": {} } }, @@ -1550,14 +1657,20 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } }, "parsedResponse": { - "target": "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse" + "target": "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse", + "traits": { + "smithy.api#documentation": "Details about the response from the Lambda parsing of the output of the post-processing step.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to postprocessing", + "smithy.api#documentation": "The foundation model output from the post-processing step.
", "smithy.api#sensitive": {} } }, @@ -1565,11 +1678,14 @@ "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#OutputString" + "target": "com.amazonaws.bedrockagentruntime#OutputString", + "traits": { + "smithy.api#documentation": "The text returned by the parser.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information if preprocessing was successful", + "smithy.api#documentation": "Details about the response from the Lambda parsing of the output from the post-processing step.
", "smithy.api#sensitive": {} } }, @@ -1577,14 +1693,20 @@ "type": "union", "members": { "modelInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "The input for the post-processing step.
\nThe type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the post-processing step.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to post processing step", + "smithy.api#documentation": "Details about the post-processing step, in which the agent shapes the response.
", "smithy.api#sensitive": {} } }, @@ -1592,14 +1714,20 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } }, "parsedResponse": { - "target": "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse" + "target": "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse", + "traits": { + "smithy.api#documentation": "Details about the response from the Lambda parsing of the output of the pre-processing step.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to preprocessing", + "smithy.api#documentation": "The foundation model output from the pre-processing step.
", "smithy.api#sensitive": {} } }, @@ -1607,17 +1735,20 @@ "type": "structure", "members": { "rationale": { - "target": "com.amazonaws.bedrockagentruntime#RationaleString" + "target": "com.amazonaws.bedrockagentruntime#RationaleString", + "traits": { + "smithy.api#documentation": "The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.
" + } }, "isValid": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Boolean value" + "smithy.api#documentation": "Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.
Details about the response from the Lambda parsing of the output from the pre-processing step.
", "smithy.api#sensitive": {} } }, @@ -1625,14 +1756,20 @@ "type": "union", "members": { "modelInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "The input for the pre-processing step.
\nThe type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the pre-processing step.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to preprocessing step", + "smithy.api#documentation": "Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
", "smithy.api#sensitive": {} } }, @@ -1643,15 +1780,11 @@ }, "value": { "target": "smithy.api#String" - }, - "traits": { - "smithy.api#documentation": "Session attributes that go to the prompt" } }, "com.amazonaws.bedrockagentruntime#PromptText": { "type": "string", "traits": { - "smithy.api#documentation": "Prompt Message", "smithy.api#sensitive": {} } }, @@ -1682,30 +1815,32 @@ "smithy.api#enumValue": "POST_PROCESSING" } } - }, - "traits": { - "smithy.api#documentation": "types of prompts" } }, "com.amazonaws.bedrockagentruntime#Rationale": { "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace step.
" + } }, "text": { - "target": "com.amazonaws.bedrockagentruntime#RationaleString" + "target": "com.amazonaws.bedrockagentruntime#RationaleString", + "traits": { + "smithy.api#documentation": "The reasoning or thought process of the agent, based on the input.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to reasoning", + "smithy.api#documentation": "Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RationaleString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Rationale String", "smithy.api#sensitive": {} } }, @@ -1715,15 +1850,18 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Reprompt response text" + "smithy.api#documentation": "The text reprompting the input.
" } }, "source": { - "target": "com.amazonaws.bedrockagentruntime#Source" + "target": "com.amazonaws.bedrockagentruntime#Source", + "traits": { + "smithy.api#documentation": "Specifies what output is prompting the agent to reprompt the input.
" + } } }, "traits": { - "smithy.api#documentation": "Observation information if there were reprompts", + "smithy.api#documentation": "Contains details about the agent's response to reprompt the input.
", "smithy.api#sensitive": {} } }, @@ -1731,11 +1869,14 @@ "type": "structure", "members": { "content": { - "target": "com.amazonaws.bedrockagentruntime#ContentMap" + "target": "com.amazonaws.bedrockagentruntime#ContentMap", + "traits": { + "smithy.api#documentation": "The content in the request body.
" + } } }, "traits": { - "smithy.api#documentation": "Request Body Content Map" + "smithy.api#documentation": "The parameters in the request body for the Lambda input event.
" } }, "com.amazonaws.bedrockagentruntime#ResourceNotFoundException": { @@ -1746,7 +1887,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a resource referenced by the operation does not exist", + "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1755,41 +1896,74 @@ "type": "union", "members": { "chunk": { - "target": "com.amazonaws.bedrockagentruntime#PayloadPart" + "target": "com.amazonaws.bedrockagentruntime#PayloadPart", + "traits": { + "smithy.api#documentation": "Contains a part of an agent response and citations for it.
" + } }, "trace": { - "target": "com.amazonaws.bedrockagentruntime#TracePart" + "target": "com.amazonaws.bedrockagentruntime#TracePart", + "traits": { + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + } }, "internalServerException": { - "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } }, "validationException": { - "target": "com.amazonaws.bedrockagentruntime#ValidationException" + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" + } }, "resourceNotFoundException": { - "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
" + } }, "serviceQuotaExceededException": { - "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
" + } }, "throttlingException": { - "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" + } }, "accessDeniedException": { - "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" + } }, "conflictException": { - "target": "com.amazonaws.bedrockagentruntime#ConflictException" + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
" + } }, "dependencyFailedException": { - "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" + } }, "badGatewayException": { - "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" + } } }, "traits": { - "smithy.api#documentation": "Response body of is a stream", + "smithy.api#documentation": "The response from invoking the agent and associated citations and trace information.
", "smithy.api#streaming": {} } }, @@ -1799,13 +1973,13 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Content of a retrieval result in text", + "smithy.api#documentation": "The cited text from the data source.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Content of a retrieval result.", + "smithy.api#documentation": "Contains the cited text from the data source.
", "smithy.api#sensitive": {} } }, @@ -1815,15 +1989,19 @@ "type": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocationType", "traits": { + "smithy.api#documentation": "The type of the location of the data source.
", "smithy.api#required": {} } }, "s3Location": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location" + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location", + "traits": { + "smithy.api#documentation": "Contains the S3 location of the data source.
" + } } }, "traits": { - "smithy.api#documentation": "The source location of a retrieval result.", + "smithy.api#documentation": "Contains information about the location of the data source.
", "smithy.api#sensitive": {} } }, @@ -1836,9 +2014,6 @@ "smithy.api#enumValue": "S3" } } - }, - "traits": { - "smithy.api#documentation": "The location type of a retrieval result." } }, "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location": { @@ -1847,12 +2022,12 @@ "uri": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "URI of S3 location" + "smithy.api#documentation": "The S3 URI of the data source.
" } } }, "traits": { - "smithy.api#documentation": "The S3 location of a retrieval result." + "smithy.api#documentation": "Contains the S3 location of the data source.
" } }, "com.amazonaws.bedrockagentruntime#Retrieve": { @@ -1893,7 +2068,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieve from knowledge base.", + "smithy.api#documentation": "Queries a knowledge base and retrieves information from it.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1945,7 +2120,7 @@ } ], "traits": { - "smithy.api#documentation": "RetrieveAndGenerate API", + "smithy.api#documentation": "Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query.
\nThe numberOfResults field is currently unsupported for RetrieveAndGenerate. Don't include it in the vectorSearchConfiguration object.
The type of resource that is queried by the request.
", "smithy.api#required": {} } }, "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrieveAndGenerateConfiguration" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the resource being queried.
" + } } }, "traits": { - "smithy.api#documentation": "Configures the retrieval and generation for the session." + "smithy.api#documentation": "Contains details about the resource being queried.
" } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateInput": { @@ -1976,7 +2155,7 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Customer input of the turn in text", + "smithy.api#documentation": "The query made to the knowledge base.
", "smithy.api#length": { "max": 1000 }, @@ -1985,7 +2164,7 @@ } }, "traits": { - "smithy.api#documentation": "Customer input of the turn", + "smithy.api#documentation": "Contains the query made to the knowledge base.
", "smithy.api#sensitive": {} } }, @@ -1995,13 +2174,13 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service response of the turn in text", + "smithy.api#documentation": "The response generated from querying the knowledge base.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Service response of the turn", + "smithy.api#documentation": "Contains the response generated from querying the knowledge base.
", "smithy.api#sensitive": {} } }, @@ -2009,19 +2188,29 @@ "type": "structure", "members": { "sessionId": { - "target": "com.amazonaws.bedrockagentruntime#SessionId" + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
" + } }, "input": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateInput", "traits": { + "smithy.api#documentation": "Contains the query made to the knowledge base.
", "smithy.api#required": {} } }, "retrieveAndGenerateConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration" + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the resource being queried and the foundation model used for generation.
" + } }, "sessionConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration" + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the session with the knowledge base.
" + } } }, "traits": { @@ -2042,17 +2231,22 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { + "smithy.api#documentation": "The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
", "smithy.api#required": {} } }, "output": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateOutput", "traits": { + "smithy.api#documentation": "Contains the response generated from querying the knowledge base.
", "smithy.api#required": {} } }, "citations": { - "target": "com.amazonaws.bedrockagentruntime#Citations" + "target": "com.amazonaws.bedrockagentruntime#Citations", + "traits": { + "smithy.api#documentation": "A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
" + } } }, "traits": { @@ -2065,13 +2259,13 @@ "kmsKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { - "smithy.api#documentation": "The KMS key arn to encrypt the customer data of the session.", + "smithy.api#documentation": "The ARN of the KMS key encrypting the session.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configures common parameters of the session." + "smithy.api#documentation": "Contains configuration about the session with the knowledge base.
" } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType": { @@ -2083,9 +2277,6 @@ "smithy.api#enumValue": "KNOWLEDGE_BASE" } } - }, - "traits": { - "smithy.api#documentation": "The type of RetrieveAndGenerate." } }, "com.amazonaws.bedrockagentruntime#RetrieveRequest": { @@ -2094,6 +2285,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2101,14 +2293,21 @@ "retrievalQuery": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery", "traits": { + "smithy.api#documentation": "The query to send the knowledge base.
", "smithy.api#required": {} } }, "retrievalConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how the results should be returned.
" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagentruntime#NextToken" + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
A list of results from querying the knowledge base.
", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagentruntime#NextToken" + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
Contains the cited text from the data source.
" + } }, "location": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation" + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", + "traits": { + "smithy.api#documentation": "Contains information about the location of the data source.
" + } } }, "traits": { - "smithy.api#documentation": "Retrieved reference" + "smithy.api#documentation": "Contains metadata about a sources cited for the generated response.
" } }, "com.amazonaws.bedrockagentruntime#RetrievedReferences": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#RetrievedReference" - }, - "traits": { - "smithy.api#documentation": "list of retrieved references" } }, "com.amazonaws.bedrockagentruntime#SearchType": { @@ -2178,9 +2384,6 @@ "smithy.api#enumValue": "SEMANTIC" } } - }, - "traits": { - "smithy.api#documentation": "Query type to be performed on data store." } }, "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException": { @@ -2191,7 +2394,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request is made beyond the service quota", + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2203,15 +2406,11 @@ }, "value": { "target": "smithy.api#String" - }, - "traits": { - "smithy.api#documentation": "Session attributes are pass through attributes passed to the action group" } }, "com.amazonaws.bedrockagentruntime#SessionId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the session.", "smithy.api#length": { "min": 2, "max": 100 @@ -2225,18 +2424,18 @@ "sessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", "traits": { - "smithy.api#documentation": "Session Attributes" + "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes.
" } }, "promptSessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", "traits": { - "smithy.api#documentation": "Prompt Session Attributes" + "smithy.api#documentation": "Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.
" } } }, "traits": { - "smithy.api#documentation": "Session state provided" + "smithy.api#documentation": "Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Session context.
" } }, "com.amazonaws.bedrockagentruntime#Source": { @@ -2262,7 +2461,6 @@ } }, "traits": { - "smithy.api#documentation": "Parsing error source", "smithy.api#sensitive": {} } }, @@ -2272,7 +2470,7 @@ "start": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Start of span", + "smithy.api#documentation": "Where the text with a citation starts in the generated output.
", "smithy.api#range": { "min": 0 } @@ -2281,7 +2479,7 @@ "end": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "End of span", + "smithy.api#documentation": "Where the text with a citation ends in the generated output.
", "smithy.api#range": { "min": 0 } @@ -2289,7 +2487,7 @@ } }, "traits": { - "smithy.api#documentation": "Span of text" + "smithy.api#documentation": "Contains information about where the text with a citation begins and ends in the generated output.
" } }, "com.amazonaws.bedrockagentruntime#StopSequences": { @@ -2298,7 +2496,6 @@ "target": "smithy.api#String" }, "traits": { - "smithy.api#documentation": "List of stop sequences", "smithy.api#length": { "min": 0, "max": 4 @@ -2308,7 +2505,6 @@ "com.amazonaws.bedrockagentruntime#Temperature": { "type": "float", "traits": { - "smithy.api#documentation": "Controls randomness, higher values increase diversity", "smithy.api#range": { "min": 0, "max": 1 @@ -2321,15 +2517,18 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Response part in text" + "smithy.api#documentation": "The part of the generated text that contains a citation.
" } }, "span": { - "target": "com.amazonaws.bedrockagentruntime#Span" + "target": "com.amazonaws.bedrockagentruntime#Span", + "traits": { + "smithy.api#documentation": "Contains information about where the text with a citation begins and ends in the generated output.
" + } } }, "traits": { - "smithy.api#documentation": "Text response part", + "smithy.api#documentation": "Contains the part of the generated text that contains a citation, alongside where it begins and ends.
", "smithy.api#sensitive": {} } }, @@ -2341,7 +2540,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the number of requests exceeds the limit", + "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2349,7 +2548,6 @@ "com.amazonaws.bedrockagentruntime#TopK": { "type": "integer", "traits": { - "smithy.api#documentation": "Sample from the k most likely next tokens", "smithy.api#range": { "min": 0, "max": 500 @@ -2359,7 +2557,6 @@ "com.amazonaws.bedrockagentruntime#TopP": { "type": "float", "traits": { - "smithy.api#documentation": "Cumulative probability cutoff for token selection", "smithy.api#range": { "min": 0, "max": 1 @@ -2370,27 +2567,38 @@ "type": "union", "members": { "preProcessingTrace": { - "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace" + "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace", + "traits": { + "smithy.api#documentation": "Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
" + } }, "orchestrationTrace": { - "target": "com.amazonaws.bedrockagentruntime#OrchestrationTrace" + "target": "com.amazonaws.bedrockagentruntime#OrchestrationTrace", + "traits": { + "smithy.api#documentation": "Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
" + } }, "postProcessingTrace": { - "target": "com.amazonaws.bedrockagentruntime#PostProcessingTrace" + "target": "com.amazonaws.bedrockagentruntime#PostProcessingTrace", + "traits": { + "smithy.api#documentation": "Details about the post-processing step, in which the agent shapes the response..
" + } }, "failureTrace": { - "target": "com.amazonaws.bedrockagentruntime#FailureTrace" + "target": "com.amazonaws.bedrockagentruntime#FailureTrace", + "traits": { + "smithy.api#documentation": "Contains information about the failure of the interaction.
" + } } }, "traits": { - "smithy.api#documentation": "Trace contains intermidate response for customer", + "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TraceId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier for trace", "smithy.api#length": { "min": 2, "max": 16 @@ -2400,7 +2608,6 @@ "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Knowledge Base Id", "smithy.api#sensitive": {} } }, @@ -2408,20 +2615,32 @@ "type": "structure", "members": { "agentId": { - "target": "com.amazonaws.bedrockagentruntime#AgentId" + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
" + } }, "agentAliasId": { - "target": "com.amazonaws.bedrockagentruntime#AgentAliasId" + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the agent.
" + } }, "sessionId": { - "target": "com.amazonaws.bedrockagentruntime#SessionId" + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session with the agent.
" + } }, "trace": { - "target": "com.amazonaws.bedrockagentruntime#Trace" + "target": "com.amazonaws.bedrockagentruntime#Trace", + "traits": { + "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains intermidate response for customer", + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", "smithy.api#sensitive": {} } }, @@ -2458,9 +2677,6 @@ "smithy.api#enumValue": "REPROMPT" } } - }, - "traits": { - "smithy.api#documentation": "types of observations" } }, "com.amazonaws.bedrockagentruntime#ValidationException": { @@ -2471,7 +2687,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the request's input validation fails", + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2479,7 +2695,6 @@ "com.amazonaws.bedrockagentruntime#Verb": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Action verb", "smithy.api#sensitive": {} } } diff --git a/codegen/sdk-codegen/aws-models/chatbot.2017-10-11.json b/codegen/sdk-codegen/aws-models/chatbot.2017-10-11.json index 4926bdd15b5..a1f088d5c74 100644 --- a/codegen/sdk-codegen/aws-models/chatbot.2017-10-11.json +++ b/codegen/sdk-codegen/aws-models/chatbot.2017-10-11.json @@ -2823,7 +2823,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "AWS Chatbot API", - "smithy.api#title": "chatbot", + "smithy.api#title": "AWS Chatbot", "smithy.api#xmlNamespace": { "uri": "http://wheatley.amazonaws.com/orchestration/2017-10-11/" }, diff --git a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json index 09d2c3711b6..5c79fb32f72 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json @@ -73,18 +73,18 @@ "Status": { "target": "com.amazonaws.cloudformation#AccountGateStatus", "traits": { - "smithy.api#documentation": "The status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account and\n Region passes any requirements for a stack set operation to occur. CloudFormation\n proceeds with the stack operation in that account and Region.
\n FAILED: The account gate function has determined that the account and Region\n doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels\n the stack set operation in that account and Region, and sets the stack set operation result\n status for that account and Region to FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate function for\n this account and Region, for one of the following reasons:
An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the stack set operation in this account and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set administration\n account lacks permissions to invoke the function. CloudFormation proceeds with the\n stack set operation in this account and Region.
Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation in this account and Region.
\nThe status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account and Region passes any\n requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and\n Region.
\n FAILED: The account gate function has determined that the account and Region doesn't meet the\n requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region,\n and sets the stack set operation result status for that account and Region to FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one\n of the following reasons:
An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the stack set\n operation in this account and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set administration account lacks\n permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and\n Region.
Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation\n in this account and Region.
\nThe reason for the account gate status assigned to this account and Region for the stack set\n operation.
" + "smithy.api#documentation": "The reason for the account gate status assigned to this account and Region for the stack set operation.
" } } }, "traits": { - "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation\n invokes, if present, before proceeding with a stack set operation in an account and\n Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda\n function that encapsulates any requirements that must be met before CloudFormation can\n proceed with a stack set operation in that account and Region. CloudFormation invokes\n the function each time a stack set operation is requested for that account and Region; if the\n function returns FAILED, CloudFormation cancels the operation in that\n account and Region, and sets the stack set operation result status for that account and Region to\n FAILED.
For more information, see Configuring a target\n account gate.
" + "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation invokes, if present, before\n proceeding with a stack set operation in an account and Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any\n requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region.\n CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the\n function returns FAILED, CloudFormation cancels the operation in that account and Region, and sets the stack\n set operation result status for that account and Region to FAILED.
For more information, see Configuring a target account\n gate.
" } }, "com.amazonaws.cloudformation#AccountGateStatus": { @@ -130,7 +130,7 @@ } }, "traits": { - "smithy.api#documentation": "The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see CloudFormation\n quotas in the CloudFormation User Guide.
" + "smithy.api#documentation": "The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#AccountLimitList": { @@ -172,7 +172,7 @@ } ], "traits": { - "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets\n and Organizations activated, the management account has permissions to create\n and manage StackSets for your organization.
" + "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets and Organizations\n activated, the management account has permissions to create and manage StackSets for your\n organization.
" } }, "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput": { @@ -206,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see\n Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use \n SetTypeConfiguration\n to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" + "smithy.api#documentation": "An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" } }, "AutoUpdate": { @@ -264,13 +264,13 @@ "VersionBump": { "target": "com.amazonaws.cloudformation#VersionBump", "traits": { - "smithy.api#documentation": "Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is\n available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is\n available.
Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is available.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of\n the major version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of the major\n version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
If set to true, StackSets automatically deploys additional stack instances to\n Organizations accounts that are added to a target organization or organizational unit\n (OU) in the specified Regions. If an account is removed from a target organization or OU,\n StackSets deletes stack instances from the account in the specified Regions.
If set to true, StackSets automatically deploys additional stack instances to Organizations\n accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account\n is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified\n Regions.
If set to true, stack resources are retained when an account is removed from a\n target organization or OU. If set to false, stack resources are deleted. Specify\n only if Enabled is set to True.
If set to true, stack resources are retained when an account is removed from a target organization\n or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to\n True.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).
" + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" } }, "com.amazonaws.cloudformation#AutoDeploymentNullable": { @@ -364,7 +364,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry\n for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { @@ -427,7 +427,7 @@ "UnprocessedTypeConfigurations": { "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any\n reason.
" + "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any reason.
" } }, "TypeConfigurations": { @@ -514,14 +514,14 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes\n all resources in the account.
The IAM policy below can be added to\n IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\":\n \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same\n name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received\n them.
A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might\n retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.
The type of entity that CloudFormation changes. Currently, the only entity type is\n Resource.
The type of entity that CloudFormation changes. Currently, the only entity type is Resource.
A ResourceChange structure that describes the resource and action that CloudFormation will\n perform.
A ResourceChange structure that describes the resource and action that CloudFormation will perform.
The Change structure describes the changes CloudFormation will perform if you execute the\n change set.
The Change structure describes the changes CloudFormation will perform if you execute the change set.
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the\n ListChangeSets operation.
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the\n ListChangeSets operation.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.
A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably\n and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build\n highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member\n resources of the stack together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information\n about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", + "smithy.api#documentation": "CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and\n repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template defines a\n collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation\n product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a\n specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", "smithy.api#title": "AWS CloudFormation", "smithy.api#xmlNamespace": { "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" @@ -2414,7 +2414,7 @@ } ], "traits": { - "smithy.api#documentation": "For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all\n changes after a failed stack update. For example, you might have a stack that's rolling back to an old database\n instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was\n deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update\n rollback to fail.
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after\n a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was\n deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance\n still exists and attempts to roll back to it, causing the update rollback to fail.
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
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.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this\n role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation\n uses this role even if the users don't have permission to pass it. Ensure that the role grants least\n permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" } }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { - "smithy.api#documentation": "A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback\n operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed.\n You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because\n an update was canceled. To check why a resource update failed, use the DescribeStackResources\n action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back.\n We recommend that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified\n resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the\n state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before\n performing another stack update, you must update the stack or resources to be consistent with each other. If you\n don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation.\n You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't\n specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update\n was canceled. To check why a resource update failed, use the DescribeStackResources action, and\n view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend\n that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to\n UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the\n skipped resources will be inconsistent with the state of the resources in the stack template. Before performing\n another stack update, you must update the stack or resources to be consistent with each other. If you don't,\n subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with\n the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name.\n You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received\n them.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you\n create a change set for an existing stack, CloudFormation compares the stack's information with the information\n that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update\n a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT\n for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,\n CloudFormation starts creating the change set. To check the status of the change set or to review it, use the\n DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change\n set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change\n set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change\n set and lists the differences. Use change sets to understand which resources CloudFormation will create or\n change, and how it will change resources in an existing stack, before you create or update a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the\n change set by comparing this stack's information with the information that you submit, such as a modified template or\n different parameter input values.
", + "smithy.api#documentation": "The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set\n by comparing this stack's information with the information that you submit, such as a modified template or different\n parameter input values.
", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the\n stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you\n specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the\n change set by comparing this template with the stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by\n comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with\n https://.
Conditional: You must specify only TemplateBody or TemplateURL.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom\n processing on templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM resources in\n CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom processing on\n templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Controlling access\n with Identity and Access Management in the CloudFormation User Guide.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation\n assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure\n that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If\n no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the\n change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future\n operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if\n the users don't have permission to pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is\n available, CloudFormation uses a temporary session that is generated from your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation\n associates with the stack. To remove all associated notification topics, specify an empty list.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates\n with the stack. To remove all associated notification topics, specify an empty list.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the\n stack. You can specify a maximum of 50 tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You\n can specify a maximum of 50 tags.
" } }, "ChangeSetName": { @@ -2565,7 +2565,7 @@ "ClientToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name.\n You might retry CreateChangeSet requests to ensure that CloudFormation successfully received\n them.
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might\n retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no\n template or resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to\n create a change set for a new stack or the CREATE type to create a change set for an existing\n stack.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or\n resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change\n set for a new stack or the CREATE type to create a change set for an existing stack.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the \n ExecuteChangeSet\n API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the \n Parameter\n \n data type.
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.
" } }, "TimeoutInMinutes": { @@ -2804,55 +2804,55 @@ "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" + "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros to perform custom\n processing on templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros to perform custom processing\n on templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a specific custom resource), AWS::service_name::* (for all resources\n of a particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a\n specific custom resource), AWS::service_name::* (for all resources of a particular\n Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific\n Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
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.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" } }, "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { - "smithy.api#documentation": "Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources\n created in the stack. A maximum number of 50 tags can be specified.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in\n the stack. A maximum number of 50 tags can be specified.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.
", + "smithy.api#documentation": "The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets\n parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template.
" + "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values\n during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use \n UpdateStackSet\n to update the stack set\n template.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" } }, "StackId": { @@ -3062,49 +3062,49 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you\n have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the stack set is not\n created.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates\n these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an\n access denied error, and the stack set is not created.
The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting\n Permissions for Stack Set Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
" + "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,\n CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users\n and groups can include in their stack sets.
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.
" + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same\n name. You might retry CreateStackSet requests to ensure that CloudFormation successfully\n received them.
If you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might\n retry CreateStackSet requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
", "smithy.api#idempotencyToken": {} } }, @@ -3170,7 +3170,7 @@ } ], "traits": { - "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated,\n the management account does not have permissions to create and manage\n service-managed StackSets for your organization.
" + "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your\n organization.
" } }, "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput": { @@ -3204,7 +3204,7 @@ } ], "traits": { - "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack\n update operations where the stack template includes the extension, even if no updates are being made to the\n extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is\n released.
", + "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations\n where the stack template includes the extension, even if no updates are being made to the extension. In addition,\n deactivated extensions aren't automatically updated if a new version of the extension is released.
", "smithy.api#idempotent": {} } }, @@ -3365,19 +3365,19 @@ "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { - "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the\n retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" + "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained\n resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "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\n behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n DeleteStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n DeleteStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.
\nFor more information, see Stack set operation\n options.
", + "smithy.api#documentation": "Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.
\nFor more information, see Stack set operation\n options.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You can retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You can retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe names of one or more Amazon Web Services accounts for which you want to deploy stack set\n updates.
" + "smithy.api#documentation": "The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
" } }, "AccountsUrl": { @@ -3568,12 +3568,12 @@ "AccountFilterType": { "target": "com.amazonaws.cloudformation#AccountFilterType", "traits": { - "smithy.api#documentation": "Limit deployment targets to individual accounts or include additional accounts with provided\n OUs.
\nThe following is a list of possible values for the AccountFilterType\n operation.
\n INTERSECTION: StackSets deploys to the accounts specified in\n Accounts parameter.
\n DIFFERENCE: StackSets excludes the accounts specified in\n Accounts parameter. This enables user to avoid certain accounts within an OU such\n as suspended accounts.
\n UNION: StackSets includes additional accounts deployment targets.
This is the default value if AccountFilterType is not provided. This enables\n user to update an entire OU and individual accounts from a different OU in one request, which\n used to be two separate requests.
\n NONE: Deploys to all the accounts in specified organizational units\n (OU).
Limit deployment targets to individual accounts or include additional accounts with provided OUs.
\nThe following is a list of possible values for the AccountFilterType operation.
\n INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.\n
\n DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This\n enables user to avoid certain accounts within an OU such as suspended accounts.
\n UNION: StackSets includes additional accounts deployment targets.
This is the default value if AccountFilterType is not provided. This enables user to update an\n entire OU and individual accounts from a different OU in one request, which used to be two separate\n requests.
\n NONE: Deploys to all the accounts in specified organizational units (OU).
[Service-managed permissions] The Organizations accounts to which StackSets deploys.\n StackSets doesn't deploy stack instances to the organization management account, even\n if the organization management account is in your organization or in an OU in your\n organization.
\nFor update operations, you can specify either Accounts or\n OrganizationalUnitIds. For create and delete operations, specify\n OrganizationalUnitIds.
[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't\n deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.
\nFor update operations, you can specify either Accounts or OrganizationalUnitIds. For\n create and delete operations, specify OrganizationalUnitIds.
Marks an extension or extension version as DEPRECATED in the CloudFormation registry,\n removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation\n operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", + "smithy.api#documentation": "Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from\n active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use \n DescribeType\n .
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in\n your account. For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", + "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.\n For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3720,7 +3720,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the\n change set. For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", + "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.\n For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -3774,7 +3774,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you\n run the change set.
" + "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the\n change set.
" } }, "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { @@ -3926,7 +3926,7 @@ "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the Parameter data type.
A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the \n Parameter\n data type.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" } }, "Capabilities": { @@ -3980,7 +3980,7 @@ "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { - "smithy.api#documentation": "A list of Change structures that describes the resources CloudFormation changes if you execute\n the change set.
A list of Change structures that describes the resources CloudFormation changes if you execute the change\n set.
Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the \n ExecuteChangeSet\n API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the \n ExecuteChangeSet\n API\n operation.
Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
Retrieves information about the account's OrganizationAccess status. This API can be called either\n by the management account or the delegated administrator by using the CallAs parameter. This API can\n also be called without the CallAs parameter by the management account.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified.
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\n administrator in the CloudFormation User Guide.
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide\n
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
\n\n \n RegisterPublisher\n \n
\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide\n
\nThe ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
The ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the\n operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use\n DescribeStackResourceDrifts to return drift information about the stack and its resources.
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" + "smithy.api#documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" } }, "com.amazonaws.cloudformation#DescribeStackInstanceInput": { @@ -4534,7 +4534,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n 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\n StackName.
Default: There is no default value.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n 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\n StackName.
Default: There is no default value.
" } } }, @@ -4766,7 +4766,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to StackName.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and\n DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to\n StackName.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -5436,31 +5436,31 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation\n returns the type name alias. For more information, see ActivateType.
" + "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the\n type name alias. For more information, see \n ActivateType\n .
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For\n more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more\n information, see \n RegisterType\n .
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation\n returns null.
Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns\n null.
The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line\n Interface User Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for\n public extensions, whether they are activated in your account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line Interface User\n Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
" + "smithy.api#documentation": "The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for\n public extensions, whether they are activated in your account.
" } }, "Description": { @@ -5472,7 +5472,7 @@ "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" + "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" } }, "ProvisioningType": { @@ -5484,13 +5484,13 @@ "DeprecatedStatus": { "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { - "smithy.api#documentation": "The deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
The deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see RegisterType.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see \n RegisterType\n .
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This\n applies only to private extensions you have registered in your account. For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your extension with the appropriate\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to\n private extensions you have registered in your account. For more information, see \n RegisterType\n .
If the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
" } }, "Visibility": { @@ -5526,7 +5526,7 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nWhen the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see \n RegisterType\n .
Public extensions you have activated in your account with auto-update specified. For more information, see\n \n ActivateType\n .
A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use \n SetTypeConfiguration\n . For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns\n null.
The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.
Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions\n for use in your account in the CloudFormation User Guide.
" + "smithy.api#documentation": "Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions for\n use in your account in the CloudFormation User Guide.
" } } }, @@ -5641,7 +5641,7 @@ "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using\n RegisterType.
", + "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using RegisterType.
", "smithy.api#required": {} } } @@ -5668,13 +5668,13 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" + "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" } }, "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { @@ -5813,7 +5830,7 @@ } ], "traits": { - "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs\n drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation\n performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" + "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift\n detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift\n detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" } }, "com.amazonaws.cloudformation#DetectStackSetDriftInput": { @@ -5830,7 +5847,7 @@ "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } }, "OperationId": { @@ -5843,7 +5860,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nStructure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack\n because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You\n can't specify a temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to\n view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't\n valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a\n temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with\n the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.
A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name.\n You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.
Preserves the state of previously provisioned resources when an operation\n fails. This parameter can't be specified when\n the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True\n
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be\n specified when the OnStackFailure parameter to the \n CreateChangeSet\n API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the \n CreateChangeSet\n API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the \n CreateChangeSet\n API operation.
Default: True\n
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.
The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName.
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If\n you specify a name, you must also specify the StackName.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has\n processed all transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has processed all\n transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with\n https://.
Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those\n actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must specify the\n 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\n an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
" } }, "CapabilitiesReason": { @@ -6619,7 +6636,7 @@ "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } }, "OperationId": { @@ -7093,7 +7110,7 @@ "code": "InvalidChangeSetStatus", "httpResponseCode": 400 }, - "smithy.api#documentation": "The specified change set can't be used to update the stack. For example, the change set status might be\n CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.
The specified change set can't be used to update the stack. For example, the change set status might be\n CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.
Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", + "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI. CloudFormation doesn't\n return this error to users.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7186,7 +7203,7 @@ "code": "LimitExceededException", "httpResponseCode": 400 }, - "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.
", + "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7206,7 +7223,7 @@ "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" }, "traits": { - "smithy.api#documentation": "Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are\n 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\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see \n CloudFormation export stack output values.
", + "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see CloudFormation export stack output\n values.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7391,7 +7408,7 @@ "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.
", + "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this value.
", "smithy.api#required": {} } }, @@ -7797,7 +7814,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most\n recent drift detection operation. If an operation is in progress, it may only return\n partial results.
Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most recent drift detection\n operation. If an operation is in progress, it may only return partial results.
The name or unique ID of the stack set that you want to list drifted resources\n for.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you want to list drifted resources for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n 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\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated\n administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in\n the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nA list of StackInstanceResourceDriftSummary structures that contain\n information about the specified stack instances.
A list of StackInstanceResourceDriftSummary structures that contain information about the specified\n stack instances.
If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n 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\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n null.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nIf the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n 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\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n 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\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on\n its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party\n publishers.
The default is PRIVATE.
The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
The default is PRIVATE.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries\n to CloudWatch Logs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
", "smithy.api#required": {} } }, @@ -8639,7 +8656,7 @@ "target": "com.amazonaws.cloudformation#LogGroupName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking\n the extension's handlers.
", + "smithy.api#documentation": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the\n extension's handlers.
", "smithy.api#required": {} } } @@ -8684,12 +8701,12 @@ "Active": { "target": "com.amazonaws.cloudformation#ManagedExecutionNullable", "traits": { - "smithy.api#documentation": "When true, StackSets performs non-conflicting operations concurrently and\n queues conflicting operations. After conflicting operations finish, StackSets starts queued\n operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations\n even if they are non-conflicting.
\nYou can't modify your stack set's execution configuration while there are running or queued\n operations for that stack set.
\nWhen false (default), StackSets performs one operation at a time in request\n order.
When true, StackSets performs non-conflicting operations concurrently and queues conflicting\n operations. After conflicting operations finish, StackSets starts queued operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations even if they are\n non-conflicting.
\nYou can't modify your stack set's execution configuration while there are running or queued operations for that\n stack set.
\nWhen false (default), StackSets performs one operation at a time in request order.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" } }, "com.amazonaws.cloudformation#ManagedExecutionNullable": { @@ -8730,7 +8747,7 @@ "TypeHierarchy": { "target": "com.amazonaws.cloudformation#TypeHierarchy", "traits": { - "smithy.api#documentation": "A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { @@ -8996,7 +9013,7 @@ "code": "ConditionalCheckFailed", "httpResponseCode": 400 }, - "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", + "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI. CloudFormation doesn't\n return this error to users.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -9113,7 +9130,7 @@ "ResolvedValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { - "smithy.api#documentation": "Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" + "smithy.api#documentation": "Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" } } }, @@ -9132,7 +9149,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be\n defined in the stack template, CloudFormation returns only the AllowedValues property.
A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in\n the stack template, CloudFormation returns only the AllowedValues property.
Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.\n Public extensions are available for use by all CloudFormation users. For more information about publishing\n extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI\n User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.
", + "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public\n extensions are available for use by all CloudFormation users. For more information about publishing extensions, see\n Publishing extensions to\n make them available for public use in the CloudFormation CLI User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more information, see \n RegisterPublisher\n .
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor\n version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor version\n release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't\n use this API in your code.
", + "smithy.api#documentation": "Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't use this API\n in your code.
", "smithy.api#idempotent": {} } }, @@ -9507,7 +9524,7 @@ "target": "com.amazonaws.cloudformation#ClientToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", "smithy.api#required": {} } }, @@ -9515,38 +9532,38 @@ "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", "smithy.api#required": {} } }, "CurrentOperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "StatusMessage": { "target": "com.amazonaws.cloudformation#StatusMessage", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "ErrorCode": { "target": "com.amazonaws.cloudformation#HandlerErrorCode", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "ResourceModel": { "target": "com.amazonaws.cloudformation#ResourceModel", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" } } }, @@ -9607,7 +9624,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public\n extensions are available for use by all CloudFormation users. This publisher ID applies to your account in\n all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
\n ", + "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are\n available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.
\n ", "smithy.api#idempotent": {} } }, @@ -9617,13 +9634,13 @@ "AcceptTermsAndConditions": { "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", "traits": { - "smithy.api#documentation": "Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the\n terms and conditions in order to register to publish public extensions to the CloudFormation\n registry.
\nThe default is false.
Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and\n conditions in order to register to publish public extensions to the CloudFormation registry.
\nThe default is false.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.
" + "smithy.api#documentation": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User Guide.
" } } }, @@ -9659,7 +9676,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for\n use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use SetTypeConfiguration to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for use in\n CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use \n DeregisterType\n to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use \n SetTypeConfiguration\n to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
A URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.
\nA URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.
\nThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when\n invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust relationship\n with the CloudFormation service principal (resources.cloudformation.amazonaws.com). For more\n information about adding trust relationships, see Modifying a\n role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this\n execution role to create a temporary session token, which it then passes to the resource type handler, thereby\n supplying your resource type with the appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust relationship with the\n CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a\n role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary\n session token, which it then passes to the resource type handler, thereby supplying your resource type with the\n appropriate credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#RequestToken", "traits": { - "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same\n registration request, even if the request is submitted multiple times.
" + "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same registration request,\n even if the request is submitted multiple times.
" } } }, @@ -9832,13 +9849,13 @@ "TypeNameAlias": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
" + "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.
" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The type name of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
The type name of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.
\nFor more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.
" + "smithy.api#documentation": "For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.
\nFor more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#RequiredActivatedTypes": { @@ -9943,7 +9960,7 @@ "Action": { "target": "com.amazonaws.cloudformation#ChangeAction", "traits": { - "smithy.api#documentation": "The action that CloudFormation takes on the resource, such as Add (adds a new resource),\n Modify (changes a resource), Remove (deletes a resource), Import (imports a\n resource), or Dynamic (exact action for the resource can't be determined).
The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify\n (changes a resource), Remove (deletes a resource), Import (imports a resource), or\n Dynamic (exact action for the resource can't be determined).
For the Modify action, indicates whether CloudFormation will replace the resource by creating a\n new one and deleting the old one. This value depends on the value of the RequiresRecreation property in\n the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is\n Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.
For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and\n deleting the old one. This value depends on the value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.
The ResourceChange structure describes the resource and the action that CloudFormation will\n perform on it if you execute this change set.
The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if\n you execute this change set.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change\n and whether the resource will be recreated.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether\n the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change\n before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will change, and its\n value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static\n evaluation.
For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change before you\n execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will change, and its value. For\n example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows\n that this property value will change, and its value, so this is a Static evaluation.
For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
The group to which the CausingEntity value belongs. There are five entity groups:
\n ResourceReference entities are Ref intrinsic functions that refer to resources in the\n template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute\n values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the template.
\n Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as\n nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation\n sets the ChangeSource to Automatic because the nested stack's template might have\n changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the\n parent stack.
The group to which the CausingEntity value belongs. There are five entity groups:
\n ResourceReference entities are Ref intrinsic functions that refer to resources in\n the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource\n attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the template.
\n Automatic entities are AWS::CloudFormation::Stack resource types, which are also\n known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might\n have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent\n stack.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types in the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types in the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources\n of that type.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of\n that type.
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.
If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
The field that CloudFormation will change, such as the name of a resource's property, and whether the\n resource will be recreated.
" + "smithy.api#documentation": "The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be\n recreated.
" } }, "com.amazonaws.cloudformation#ResourceToImport": { @@ -10559,7 +10576,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.
The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.
A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).
A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).
The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers\n after the stack creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits\n the specified period of time before cleaning up old resources after update operations. You can use this monitoring\n period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers\n during stack creation and update operations. Then, for update operations, it begins disposing of old resources\n immediately once the operation completes.
" + "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack\n creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified\n period of time before cleaning up old resources after update operations. You can use this monitoring period to\n perform any manual stack validation desired, and manually cancel the stack creation or update (using \n CancelUpdateStack\n , for example) as necessary.
If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack\n creation and update operations. Then, for update operations, it begins disposing of old resources immediately once\n the operation completes.
" } } }, @@ -10735,7 +10752,7 @@ } ], "traits": { - "smithy.api#documentation": "When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", + "smithy.api#documentation": "The resource type of the rollback trigger. Specify either \n AWS::CloudWatch::Alarm\n or \n AWS::CloudWatch::CompositeAlarm\n resource types.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n Resource type support In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must\n start with https://. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Specifies the configuration data for a registered CloudFormation extension, in the given account and\n Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of DescribeType. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User\n Guide.
\nSpecifies the configuration data for a registered CloudFormation extension, in the given account and Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of \n DescribeType\n . For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User Guide.
\nThe Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the \n ActivateType\n API operation\n in this account and Region. For private extensions, this will be the ARN assigned when you call the \n RegisterType\n API operation in this account and Region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.
" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of DescribeType. For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of \n DescribeType\n . For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation\n doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout\n period is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't\n proceed with a stack creation or update until resources receive the required number of signals or the timeout period\n is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
The status of the signal, which is either success or failure. A failure signal causes CloudFormation to\n immediately fail the stack creation or update.
", + "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately\n fail the stack creation or update.
", "smithy.api#required": {} } } @@ -11195,7 +11212,7 @@ "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" } }, "StackStatus": { @@ -11245,7 +11262,7 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the\n stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.\n During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" } }, "Tags": { @@ -11281,7 +11298,13 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or\n resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets\n CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment in\n the CloudFormation User Guide.
Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
" + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
" } }, "Timestamp": { @@ -11471,7 +11494,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Specify the hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
An optional field containing information about the detailed status of the stack event.
\n\n CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment\n in the CloudFormation User Guide.
\n VALIDATION_FAILED - template validation failed because of invalid properties in the template. The\n ResourceStatusReason field shows what properties are defined incorrectly.
[Self-managed permissions] The name of the Amazon Web Services account that the stack\n instance is associated with.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" } }, "StackId": { @@ -11564,13 +11593,13 @@ "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of parameters from the stack set template whose values have been overridden in this\n stack instance.
" + "smithy.api#documentation": "A list of parameters from the stack set template whose values have been overridden in this stack\n instance.
" } }, "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack\n set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be\n returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once\n the failures are fixed. To see if this is due to a failed import, look at the DetailedStatus member in\n the StackInstanceSummary member that is a peer to this Status\n member.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter\n configuration of the stack set to which it belongs. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected stack set configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack\n set configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the\n stack instance. This value will be NULL for any stack instance on which drift\n detection hasn't yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be\n NULL for any stack instance on which drift detection hasn't yet been performed.
An CloudFormation stack, in a specific account and Region, that's part of a stack set\n operation. A stack instance is a reference to an attempted or actual stack in a given account\n within a given Region. A stack instance can exist without a stack—for example, if the stack\n couldn't be created for some reason. A stack instance is associated with only one stack set. Each\n stack instance contains the ID of its associated stack set, in addition to the ID of the actual\n stack and the stack status.
" + "smithy.api#documentation": "An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a\n reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist\n without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with\n only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the\n actual stack and the stack status.
" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { @@ -11620,7 +11649,7 @@ "DetailedStatus": { "target": "com.amazonaws.cloudformation#StackInstanceDetailedStatus", "traits": { - "smithy.api#documentation": "\n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the stack set operation, or because the\n failure tolerance of the stack set operation has been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the\n stack set operation fails in enough accounts within a Region, the failure tolerance for the\n stack set operation as a whole might be exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to\n start.
\n RUNNING: The operation in the specified account and Region is currently in\n progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region\n has been skipped because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed\n successfully.
\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the stack set operation\n fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be\n exceeded.
\n FAILED_IMPORT: The import of the stack instance in the specified account and Region failed and\n left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be\n retried. If enough stack set operations fail in enough accounts within a Region, the failure tolerance for the\n stack set operation as a whole might be exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to start.
\n RUNNING: The operation in the specified account and Region is currently in progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped\n because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" } }, "PhysicalResourceIdContext": { "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { - "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough\n to uniquely identify that resource. Each context key-value pair specifies a unique resource\n that contains the targeted resource.
" + "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a unique resource that contains the targeted resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, "PropertyDifferences": { "target": "com.amazonaws.cloudformation#PropertyDifferences", "traits": { - "smithy.api#documentation": "Status of the actual configuration of the resource compared to its expected\n configuration. These will be present only for resources whose\n StackInstanceResourceDriftStatus is MODIFIED.
Status of the actual configuration of the resource compared to its expected configuration. These will be present\n only for resources whose StackInstanceResourceDriftStatus is MODIFIED.
The drift status of the resource in a stack instance.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected template\n values.
\n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The drift status of the resource in a stack instance.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The structure containing summary information about resource drifts for a stack\n instance.
" + "smithy.api#documentation": "The structure containing summary information about resource drifts for a stack instance.
" } }, "com.amazonaws.cloudformation#StackInstanceStatus": { @@ -11876,7 +11911,7 @@ "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack\n instance is associated with.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" } }, "StackId": { @@ -11888,7 +11923,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack\n set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be\n returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once\n the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance\n API operation, look at the DetailedStatus member returned in the StackInstanceSummary\n member.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter\n configuration of the stack set to which it belongs. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected stack set configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack\n set configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the\n stack instance. This value will be NULL for any stack instance on which drift\n detection hasn't yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be\n NULL for any stack instance on which drift detection hasn't yet been performed.
Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, @@ -12112,7 +12147,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, @@ -12248,7 +12283,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nResources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" + "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nResources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformation": { @@ -12258,7 +12293,7 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { @@ -12280,7 +12315,7 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n 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\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any\n resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more\n information about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n 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\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources\n included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information\n about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftStatus": { @@ -12369,7 +12404,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
", + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
", "smithy.api#required": {} } }, @@ -12436,7 +12471,7 @@ "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or\n updated.
" + "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" } }, "Status": { @@ -12448,7 +12483,7 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update the\n stack set.
" + "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update the stack set.
" } }, "Parameters": { @@ -12460,13 +12495,13 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include\n resources that can affect permissions in your Amazon Web Services account—for example, by creating\n new Identity and Access Management (IAM) users. For more information, see Acknowledging\n IAM Resources in CloudFormation Templates.\n
" + "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n 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\n Templates.\n
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50 tags can\n be specified.
" + "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50 tags can be\n specified.
" } }, "StackSetARN": { @@ -12478,54 +12513,54 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the\n stack set.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack\n set.
\nUse customized execution roles to control which stack resources users and groups can include\n in their stack sets.
" + "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations currently in progress\n isn't included.
" + "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations currently in progress isn't included.
" } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).
" + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are\n created.
\nWith self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n Self-Managed Stack Set Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more\n information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances\n deployed in. The Amazon Web Services Regions list output is in no particular order.
" + "smithy.api#documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
" } } }, "traits": { - "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to\n provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any\n parameters and capabilities that the template requires.
" + "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to provision stacks into\n Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify\n the template to use, in addition to any parameters and capabilities that the template requires.
" } }, "com.amazonaws.cloudformation#StackSetARN": { @@ -12537,19 +12572,19 @@ "DriftStatus": { "target": "com.amazonaws.cloudformation#StackSetDriftStatus", "traits": { - "smithy.api#documentation": "Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its stack\n instances have drifted from their expected template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack\n differs from the expected template and parameter configuration. A stack instance is considered\n to have drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All of the stack instances belonging to the stack set stack match\n from the expected template and parameter configuration.
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
The status of the stack set drift detection operation.
\n\n COMPLETED: The drift detection operation completed without failing on any\n stack instances.
\n FAILED: The drift detection operation exceeded the specified failure\n tolerance.
\n PARTIAL_SUCCESS: The drift detection operation completed without exceeding\n the failure tolerance for the operation.
\n IN_PROGRESS: The drift detection operation is currently being\n performed.
\n STOPPED: The user has canceled the drift detection operation.
The status of the stack set drift detection operation.
\n\n COMPLETED: The drift detection operation completed without failing on any stack instances.
\n FAILED: The drift detection operation exceeded the specified failure tolerance.
\n PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance\n for the operation.
\n IN_PROGRESS: The drift detection operation is currently being performed.
\n STOPPED: The user has canceled the drift detection operation.
Most recent time when CloudFormation performed a drift detection operation on the\n stack set. This value will be NULL for any stack set on which drift detection hasn't\n yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be\n NULL for any stack set on which drift detection hasn't yet been performed.
The number of stack instances that have drifted from the expected template and parameter\n configuration of the stack set. A stack instance is considered to have drifted if one or more of\n the resources in the associated stack don't match their expected configuration.
" + "smithy.api#documentation": "The number of stack instances that have drifted from the expected template and parameter configuration of the\n stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack\n don't match their expected configuration.
" } }, "InSyncStackInstancesCount": { "target": "com.amazonaws.cloudformation#InSyncStackInstancesCount", "traits": { - "smithy.api#documentation": "The number of stack instances which match the expected template and parameter configuration\n of the stack set.
" + "smithy.api#documentation": "The number of stack instances which match the expected template and parameter configuration of the stack\n set.
" } }, "InProgressStackInstancesCount": { @@ -12584,7 +12619,7 @@ } }, "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations in-progress isn't\n included.
\nFor stack set operations, includes information about drift operations currently being\n performed on the stack set.
\nFor more information, see Detecting unmanaged changes in\n stack sets in the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations in-progress isn't included.
\nFor stack set operations, includes information about drift operations currently being performed on the stack\n set.
\nFor more information, see Detecting unmanaged changes in stack sets in\n the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#StackSetDriftDetectionStatus": { @@ -12709,13 +12744,13 @@ "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { - "smithy.api#documentation": "The type of stack set operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack set instances\n that are associated with the specified stack set. Update operations affect both the stack set\n itself, in addition to all associated stack set instances.
The type of stack set operation: CREATE, UPDATE, or DELETE. Create and\n delete operations affect only the specified stack set instances that are associated with the specified stack set.\n Update operations affect both the stack set itself, in addition to all associated stack set\n instances.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation\n cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the stack\n set operation status codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
For stack set operations of action type DELETE, specifies whether to remove the\n stack instances from the specified stack set, but doesn't delete the stacks. You can't\n re-associate a retained stack, or add an existing, saved stack to a new stack set.
For stack set operations of action type DELETE, specifies whether to remove the stack instances\n from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an\n existing, saved stack to a new stack set.
The Amazon Resource Name (ARN) of the IAM role used to perform this stack set\n operation.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define\n Permissions for Multiple Administrators in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack\n set.
\nUse customized execution roles to control which stack resources users and groups can include\n in their stack sets.
" + "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" } }, "CreationTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack\n set operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as\n dispatching the work to the requested Regions, before actually creating the first stacks.
" + "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory\n work for the operation, such as dispatching the work to the requested Regions, before actually creating the first\n stacks.
" } }, "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the stack set operation was successful, or even\n attempted, in each account or Region.
" + "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts affected by the stack\n operation.
" + "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts affected by the stack operation.
" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information\n about drift operations currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action\n type is DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in\n Stack Sets in the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in\n the CloudFormation User Guide.
" } }, "StatusReason": { @@ -12818,7 +12853,7 @@ "RegionConcurrencyType": { "target": "com.amazonaws.cloudformation#RegionConcurrencyType", "traits": { - "smithy.api#documentation": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or\n one Region at a time.
" + "smithy.api#documentation": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a\n time.
" } }, "RegionOrder": { @@ -12830,36 +12865,36 @@ "FailureToleranceCount": { "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { - "smithy.api#documentation": "The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n CloudFormation doesn't attempt the operation in any subsequent Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in\n that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail before\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n CloudFormation doesn't attempt the operation in any subsequent Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation\n in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The maximum number of accounts in which to perform this operation at one time. This can\n depend on the value of FailureToleranceCount depending on your\n ConcurrencyMode. MaxConcurrentCount is at most one more than the\n FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For\n large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum number of accounts in which to perform this operation at one time. This can depend on the value of\n FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is\n at most one more than the FailureToleranceCount if you're using\n STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding\n down would result is zero. In this case, CloudFormation sets the number as one\n instead.
\nNote that this setting lets you specify the maximum for operations. For\n large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next\n whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
\nNote that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
Specifies how the concurrency level behaves during the operation execution.
\n\n STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency\n level to ensure the number of failed accounts never exceeds the value of\n FailureToleranceCount +1. The initial actual concurrency is set to the lower of\n either the value of the MaxConcurrentCount, or the value of\n MaxConcurrentCount +1. The actual concurrency is then reduced proportionally by\n the number of failures. This is the default behavior.
If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior\n is similar.
\n\n SOFT_FAILURE_TOLERANCE: This option decouples\n FailureToleranceCount from the actual concurrency. This allows stack set\n operations to run at the concurrency level set by the MaxConcurrentCount value, or\n MaxConcurrentPercentage, regardless of the number of failures.
Specifies how the concurrency level behaves during the operation execution.
\n\n STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the\n number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual\n concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of\n MaxConcurrentCount +1. The actual concurrency is then reduced proportionally by the number of\n failures. This is the default behavior.
If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
\n\n SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual\n concurrency. This allows stack set operations to run at the concurrency level set by the\n MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of\n failures.
The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set\n operation options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } }, "com.amazonaws.cloudformation#StackSetOperationResultStatus": { @@ -12909,7 +12944,7 @@ "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account for this operation\n result.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
" } }, "Region": { @@ -12921,7 +12956,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", "traits": { - "smithy.api#documentation": "The result status of the stack set operation for the given account in the given\n Region.
\n\n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the stack set operation, or because the\n failure tolerance of the stack set operation has been exceeded.
\n FAILED: The operation in the specified account and Region failed.
If the stack set operation fails in enough accounts within a Region, the failure tolerance\n for the stack set operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is currently in\n progress.
\n PENDING: The operation in the specified account and Region has yet to\n start.
\n SUCCEEDED: The operation in the specified account and Region completed\n successfully.
The result status of the stack set operation for the given account in the given Region.
\n\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed.
If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set\n operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is currently in progress.
\n PENDING: The operation in the specified account and Region has yet to start.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The results of the account gate function CloudFormation invokes, if present, before\n proceeding with stack set operations in an account.
" + "smithy.api#documentation": "The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations\n in an account.
" } }, "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { - "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that\n you specified for DeploymentTargets.
" + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n \n DeploymentTargets\n .
The structure that contains information about a specified operation's results for a given\n account in a given Region.
" + "smithy.api#documentation": "The structure that contains information about a specified operation's results for a given account in a given\n Region.
" } }, "com.amazonaws.cloudformation#StackSetOperationStatus": { @@ -13023,25 +13058,25 @@ "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { - "smithy.api#documentation": "The type of operation: CREATE, UPDATE, or DELETE.\n Create and delete operations affect only the specified stack instances that are associated with\n the specified stack set. Update operations affect both the stack set itself and\n all associated stack set instances.
The type of operation: CREATE, UPDATE, or DELETE. Create and delete\n operations affect only the specified stack instances that are associated with the specified stack set. Update\n operations affect both the stack set itself and all associated stack set instances.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation\n cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the stack\n set operation status codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the stack\n set operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as\n dispatching the work to the requested Regions, before actually creating the first stacks.
" + "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory\n work for the operation, such as dispatching the work to the requested Regions, before actually creating the first\n stacks.
" } }, "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the stack set operation was successful, or even\n attempted, in each account or Region.
" + "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" } }, "StatusReason": { @@ -13059,7 +13094,7 @@ "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set\n operation options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } } }, @@ -13108,7 +13143,7 @@ "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or\n updated.
" + "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" } }, "Status": { @@ -13120,31 +13155,31 @@ "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
" + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organizational unit (OU).
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are\n created.
\nWith self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n Self-Managed Stack Set Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more\n information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its stack\n instances have drifted from their expected template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack\n differs from the expected template and parameter configuration. A stack instance is considered\n to have drifted if one or more of the resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All the stack instances belonging to the stack set stack match from\n the expected template and parameter configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the\n stack set. This value will be NULL for any stack set on which drift detection hasn't\n yet been performed.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be\n NULL for any stack set on which drift detection hasn't yet been performed.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" } } }, @@ -13505,7 +13540,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops an in-progress operation on a stack set and its associated stack instances. StackSets\n will cancel all the unstarted stack instance deployments and wait for those are in-progress to\n complete.
" + "smithy.api#documentation": "Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the\n unstarted stack instance deployments and wait for those are in-progress to complete.
" } }, "com.amazonaws.cloudformation#StopStackSetOperationInput": { @@ -13530,7 +13565,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a member\n account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n\n Required. A string used to identify this tag. You can specify a maximum of 128 characters for a\n tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.
\n Required. A string used to identify this tag. You can specify a maximum of 128 characters\n for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix:\n aws:.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your\n account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered.\n For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into DescribeType to monitor the current test\n status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your account and Region\n for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered. For more\n information, see \n RegisterType\n .
Once you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into \n DescribeType\n to monitor the current test\n status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this\n account and Region for testing.
" + "smithy.api#documentation": "The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region\n for testing.
" } }, "LogDeliveryBucket": { "target": "com.amazonaws.cloudformation#S3Bucket", "traits": { - "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been\n assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" + "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a\n test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" } } }, @@ -14060,19 +14095,19 @@ "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { - "smithy.api#documentation": "A JSON string specifying the configuration data for the extension, in this account and Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n {}.
A JSON string specifying the configuration data for the extension, in this account and Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns {}.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n null.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns null.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the \n ActivateType\n API operation in\n this account and Region. For private extensions, this will be the ARN assigned when you call the \n RegisterType\n API operation in this account and Region.
Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { @@ -14104,7 +14139,7 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the \n ActivateType\n API operation in\n this account and Region. For private extensions, this will be the ARN assigned when you call the \n RegisterType\n API operation in this account and Region.
The name of the extension.
\nIf you specified a TypeNameAlias when you activate this extension in your account\n and Region, CloudFormation considers that alias as the type name.
The name of the extension.
\nIf you specified a TypeNameAlias when you call the \n ActivateType\n API operation in\n your account and Region, CloudFormation considers that alias as the type name.
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more\n information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more information, see\n \n RegisterType\n .
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "TypeArn": { @@ -14281,7 +14316,7 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nFor all other extension types, CloudFormation returns null.
When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see \n RegisterType\n .
Public extensions you have activated in your account with auto-update specified. For more information, see\n \n ActivateType\n .
For all other extension types, CloudFormation returns null.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
The service used to verify the publisher identity.
\nFor more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension\n Development.
" + "smithy.api#documentation": "The service used to verify the publisher identity.
\nFor more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
" } }, "PublisherName": { @@ -14440,7 +14475,7 @@ "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated\n third-arty extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-arty\n extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the \n Parameter\n \n data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros to Perform Custom\n Processing on Templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros to Perform Custom Processing\n on Templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this update stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this update stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
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.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that is generated from your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.
" } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates\n with the stack. Specify an empty list to remove all notification topics.
" + "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.\n Specify an empty list to remove all notification topics.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported\n resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an\n empty value, CloudFormation removes all associated tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the\n stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value,\n CloudFormation removes all associated tags.
" } }, "DisableRollback": { @@ -14712,13 +14747,13 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use UpdateStackSet to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use \n CreateStackInstances\n .
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use \n UpdateStackSet\n to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use \n UpdateStackSet\n to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.
", + "smithy.api#documentation": "The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of input parameters whose values you want to update for the specified stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets\n parameter values during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
A list of input parameters whose values you want to update for the specified stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values\n during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use \n UpdateStackSet\n to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::AccessKey\n \n
\n \n AWS::IAM::Group\n \n
\n \n AWS::IAM::Policy\n \n
\n \n AWS::IAM::Role\n \n
\n \n AWS::IAM::User\n \n
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the \n AWS::Include\n and \n AWS::Serverless\n transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50\n tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
\nIf you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if\n you have the required IAM permission to tag resources. If you omit tags that are currently associated\n with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags\n from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary\n permission(s), the entire UpdateStackSet action fails with an access denied error, and the\n stack set is not updated.
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these\n tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
\nIf you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from\n the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see\n if you have permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the stack set is not\n updated.
The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.
" + "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify an execution role,\n CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users\n and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.
" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.
\nTo update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.
If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances\n with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with\n their existing stack instance status.
[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.
\nTo update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.
If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status\n of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances\n in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance\n status.
Describes how the IAM roles required for stack set operations are created. You cannot modify\n PermissionModel if there are stack instances associated with your stack set.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Describes how the IAM roles required for stack set operations are created. You cannot modify\n PermissionModel if there are stack instances associated with your stack set.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nUpdates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { @@ -15088,7 +15123,7 @@ "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { - "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't,\n CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation\n returns a template validation error.
" + "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation\n checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation\n error.
" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { @@ -15097,13 +15132,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
The capabilities found within the template. If your template contains IAM resources, you must\n 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\n an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must specify the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or\n UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities\n error.
\nFor more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
" } }, "CapabilitiesReason": { diff --git a/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json b/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json index b3f472e6ad8..20883be5d27 100644 --- a/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json +++ b/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json @@ -251,7 +251,7 @@ } }, "traits": { - "smithy.api#documentation": "Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those\n events that are important to you. For more information about advanced event selectors, see\n Logging data events in the CloudTrail User Guide.
\n\n readOnly\n
\n eventSource\n
\n eventName\n
\n eventCategory\n
\n resources.type\n
\n resources.ARN\n
You cannot apply both event selectors and advanced event selectors to a trail.
" + "smithy.api#documentation": "Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those\n events that are important to you. For more information about advanced event selectors, see\n Logging management events and \n Logging data events in the CloudTrail User Guide.
\nYou cannot apply both event selectors and advanced event selectors to a trail.
\n\n Supported CloudTrail event record fields for management events\n
\n\n eventCategory (required)
\n eventSource\n
\n readOnly\n
\n Supported CloudTrail event record fields for data events\n
\n\n eventCategory (required)
\n resources.type (required)
\n readOnly\n
\n eventName\n
\n resources.ARN\n
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.
A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.
\nFor CloudTrail management events, supported fields include readOnly,\n eventCategory, and eventSource.
For CloudTrail data events, supported fields include readOnly,\n eventCategory, eventName, resources.type, and resources.ARN.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.
\n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.
\n \n eventSource\n - For filtering\n management events only. This can be set to NotEquals\n kms.amazonaws.com or NotEquals\n rdsdata.amazonaws.com.
\n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.
\n \n eventCategory\n - This is required and\n must be set to Equals. \n
\n For CloudTrail management events, the value\n must be Management. \n
\n For CloudTrail data events, the value\n must be Data. \n
The following are used only for event data stores:
\n\n For CloudTrail Insights events, the value\n must be Insight. \n
\n For Config\n configuration items, the value must be ConfigurationItem.\n
\n For Audit Manager evidence, the value must be Evidence.\n
\n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n
\n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
\n AWS::B2BI::Transformer\n
\n AWS::Bedrock::AgentAlias\n
\n AWS::Bedrock::KnowledgeBase\n
\n AWS::Cassandra::Table\n
\n AWS::CloudFront::KeyValueStore\n
\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Customization\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::IoTTwinMaker::Entity\n
\n AWS::IoTTwinMaker::Workspace\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::KinesisVideo::Stream\n
\n AWS::ManagedBlockchain::Network\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::MedicalImaging::Datastore\n
\n AWS::NeptuneGraph::Graph\n
\n AWS::PCAConnectorAD::Connector\n
\n AWS::QBusiness::Application\n
\n AWS::QBusiness::DataSource\n
\n AWS::QBusiness::Index\n
\n AWS::QBusiness::WebExperience\n
\n AWS::RDS::DBCluster\n
\n AWS::SageMaker::Endpoint\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::ServiceDiscovery::Namespace \n
\n AWS::ServiceDiscovery::Service\n
\n AWS::SCN::Instance\n
\n AWS::SNS::PlatformEndpoint\n
\n AWS::SNS::Topic\n
\n AWS::SQS::Queue\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
\n AWS::SSMMessages::ControlChannel\n
\n AWS::ThinClient::Device\n
\n AWS::ThinClient::Environment\n
\n AWS::Timestream::Database\n
\n AWS::Timestream::Table\n
\n AWS::VerifiedPermissions::PolicyStore\n
You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.
\n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. For\n example, if resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.
\n\n arn:\n
\n arn:\n
When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::B2BI::Transformer, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Bedrock::AgentAlias, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cassandra::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CodeWhisperer::Customization, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::IoTTwinMaker::Entity,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::IoTTwinMaker::Workspace,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::KinesisVideo::Stream, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Network,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::MedicalImaging::Datastore,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::NeptuneGraph::Graph,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::PCAConnectorAD::Connector,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::Application,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::DataSource,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::Index,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::WebExperience,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::RDS::DBCluster,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SCN::Instance, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SNS::PlatformEndpoint,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SNS::Topic,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SQS::Queue,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.
\n arn:\n
\n arn:\n
When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:
\n arn:\n
When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::SSMMessages::ControlChannel, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::ThinClient::Device, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::ThinClient::Environment, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::Timestream::Database,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Timestream::Table,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.
\nFor CloudTrail management events, supported fields include readOnly,\n eventCategory, and eventSource.
For CloudTrail data events, supported fields include readOnly,\n eventCategory, eventName, resources.type, and resources.ARN.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.
\n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.
\n \n eventSource\n - For filtering\n management events only. This can be set to NotEquals\n kms.amazonaws.com or NotEquals\n rdsdata.amazonaws.com.
\n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.
\n \n eventCategory\n - This is required and\n must be set to Equals. \n
\n For CloudTrail management events, the value\n must be Management. \n
\n For CloudTrail data events, the value\n must be Data. \n
The following are used only for event data stores:
\n\n For CloudTrail Insights events, the value\n must be Insight. \n
\n For Config\n configuration items, the value must be ConfigurationItem.\n
\n For Audit Manager evidence, the value must be Evidence.\n
\n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n
\n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
\n AWS::AppConfig::Configuration\n
\n AWS::B2BI::Transformer\n
\n AWS::Bedrock::AgentAlias\n
\n AWS::Bedrock::KnowledgeBase\n
\n AWS::Cassandra::Table\n
\n AWS::CloudFront::KeyValueStore\n
\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Customization\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GreengrassV2::ComponentVersion\n
\n AWS::GreengrassV2::Deployment\n
\n AWS::GuardDuty::Detector\n
\n AWS::IoT::Certificate\n
\n AWS::IoT::Thing\n
\n AWS::IoTSiteWise::Asset\n
\n AWS::IoTSiteWise::TimeSeries\n
\n AWS::IoTTwinMaker::Entity\n
\n AWS::IoTTwinMaker::Workspace\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::KinesisVideo::Stream\n
\n AWS::ManagedBlockchain::Network\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::MedicalImaging::Datastore\n
\n AWS::NeptuneGraph::Graph\n
\n AWS::PCAConnectorAD::Connector\n
\n AWS::QBusiness::Application\n
\n AWS::QBusiness::DataSource\n
\n AWS::QBusiness::Index\n
\n AWS::QBusiness::WebExperience\n
\n AWS::RDS::DBCluster\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
\n AWS::SageMaker::Endpoint\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::ServiceDiscovery::Namespace \n
\n AWS::ServiceDiscovery::Service\n
\n AWS::SCN::Instance\n
\n AWS::SNS::PlatformEndpoint\n
\n AWS::SNS::Topic\n
\n AWS::SWF::Domain\n
\n AWS::SQS::Queue\n
\n AWS::SSMMessages::ControlChannel\n
\n AWS::ThinClient::Device\n
\n AWS::ThinClient::Environment\n
\n AWS::Timestream::Database\n
\n AWS::Timestream::Table\n
\n AWS::VerifiedPermissions::PolicyStore\n
You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.
\n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. For\n example, if resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.
\n\n arn:\n
\n arn:\n
When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::AppConfig::Configuration, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::B2BI::Transformer, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Bedrock::AgentAlias, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cassandra::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CodeWhisperer::Customization, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::GreengrassV2::ComponentVersion, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::GreengrassV2::Deployment, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:
When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::IoT::Certificate,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::IoT::Thing,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::IoTSiteWise::Asset,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::IoTSiteWise::TimeSeries,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::IoTTwinMaker::Entity,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::IoTTwinMaker::Workspace,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::KinesisVideo::Stream, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Network,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::MedicalImaging::Datastore,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::NeptuneGraph::Graph,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::PCAConnectorAD::Connector,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::Application,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::DataSource,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::Index,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::QBusiness::WebExperience,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::RDS::DBCluster,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.
\n arn:\n
\n arn:\n
When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:
\n arn:\n
When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SCN::Instance, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SNS::PlatformEndpoint,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SNS::Topic,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SWF::Domain,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SQS::Queue,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SSMMessages::ControlChannel, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::ThinClient::Device, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::ThinClient::Environment, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::Timestream::Database,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Timestream::Table,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
Specifies a value for the specified AttributeKey.
", + "smithy.api#documentation": "Specifies a value for the specified AttributeKey.
The maximum length for the AttributeValue is 2000 characters. The\n following characters ('_', ' ', ',',\n '\\\\n') count as two characters towards the 2000 character limit.
Starts running a build.
" + "smithy.api#documentation": "Starts running a build with the settings defined in the project. These setting include: how to run a build, \n where to get the source code, which build environment to use, which build commands to run, and where to store the build output.
\nYou can also start a build run by overriding some of the build settings in the project. The overrides only apply for that \n specific start build request. The settings in the project are unaltered.
" } }, "com.amazonaws.codebuild#StartBuildBatch": { @@ -7840,7 +7840,7 @@ "buildspecOverride": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.
\n If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.
A buildspec file declaration that overrides the latest one defined \n in the build project, for this build only. The buildspec defined on the project is not changed.
\nIf this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, \n you should note that an IAM principal with the ability to call this API and set this parameter \n can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location \n like a file in your source repository or a Amazon S3 bucket.
\n The type of webhook filter. There are six webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, and COMMIT_MESSAGE.
A webhook event triggers a build when the provided pattern\n matches one of five event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED,\n PULL_REQUEST_REOPENED, and\n PULL_REQUEST_MERGED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.
The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only.
A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n
A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.\n
\n A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.
Works with pull request events only.
\n A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\nA webhook triggers a build when the head commit message matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\n The type of webhook filter. There are six webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, and COMMIT_MESSAGE.
\n EVENT\n
\n A webhook event triggers a build when the provided pattern\n matches one of six event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, \n PULL_REQUEST_CLOSED, \n PULL_REQUEST_REOPENED, and\n PULL_REQUEST_MERGED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.
The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only.
ACTOR_ACCOUNT_ID
\n A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n
HEAD_REF
\n A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.\n
\nBASE_REF
\n A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.
Works with pull request events only.
\nFILE_PATH
\n A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\nCOMMIT_MESSAGE
\nA webhook triggers a build when the head commit message matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\nThe type of sync configuration.
", "smithy.api#required": {} } + }, + "PublishDeploymentStatus": { + "target": "com.amazonaws.codestarconnections#PublishDeploymentStatus", + "traits": { + "smithy.api#documentation": "Whether to enable or disable publishing of deployment status to source providers.
" + } + }, + "TriggerResourceUpdateOn": { + "target": "com.amazonaws.codestarconnections#TriggerResourceUpdateOn", + "traits": { + "smithy.api#documentation": "When to trigger Git sync to begin the stack update.
" + } } }, "traits": { @@ -2847,6 +2859,23 @@ } } }, + "com.amazonaws.codestarconnections#PublishDeploymentStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.codestarconnections#RepositoryLinkArn": { "type": "string", "traits": { @@ -3581,6 +3610,18 @@ "smithy.api#documentation": "The type of sync for a specific sync configuration.
", "smithy.api#required": {} } + }, + "PublishDeploymentStatus": { + "target": "com.amazonaws.codestarconnections#PublishDeploymentStatus", + "traits": { + "smithy.api#documentation": "Whether to enable or disable publishing of deployment status to source providers.
" + } + }, + "TriggerResourceUpdateOn": { + "target": "com.amazonaws.codestarconnections#TriggerResourceUpdateOn", + "traits": { + "smithy.api#documentation": "When to trigger Git sync to begin the stack update.
" + } } }, "traits": { @@ -3761,6 +3802,23 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.codestarconnections#TriggerResourceUpdateOn": { + "type": "enum", + "members": { + "ANY_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY_CHANGE" + } + }, + "FILE_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_CHANGE" + } + } + } + }, "com.amazonaws.codestarconnections#Type": { "type": "string" }, @@ -4160,6 +4218,18 @@ "smithy.api#documentation": "The sync type for the sync configuration to be updated.
", "smithy.api#required": {} } + }, + "PublishDeploymentStatus": { + "target": "com.amazonaws.codestarconnections#PublishDeploymentStatus", + "traits": { + "smithy.api#documentation": "Whether to enable or disable publishing of deployment status to source providers.
" + } + }, + "TriggerResourceUpdateOn": { + "target": "com.amazonaws.codestarconnections#TriggerResourceUpdateOn", + "traits": { + "smithy.api#documentation": "When to trigger Git sync to begin the stack update.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json b/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json index a321f56bc7c..5770dc03be0 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json @@ -1510,7 +1510,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Resets the specified user's password in a user pool as an administrator. Works on any\n user.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nDeactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nResets the specified user's password in a user pool as an administrator. Works on any\n user.
\nTo use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nDeactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.
To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character. For example,\n \"family_name = \\\"Reddy\\\"\".
\n AttributeName: The name of the attribute to search for.\n You can only search for one attribute at a time.
\n\n Filter-Type: For an exact match, use =, for example,\n \"given_name = \\\"Jon\\\"\". For a prefix (\"starts with\") match, use\n ^=, for example, \"given_name ^= \\\"Jon\\\"\".
\n AttributeValue: The attribute value that must be matched\n for each user.
\nIf the filter string is empty, ListUsers returns all users in the user\n pool.
You can only search for the following standard attributes:
\n\n username (case-sensitive)
\n email\n
\n phone_number\n
\n name\n
\n given_name\n
\n family_name\n
\n preferred_username\n
\n cognito:user_status (called Status in the Console) (case-insensitive)
\n status (called Enabled in the Console)\n (case-sensitive)\n
\n sub\n
Custom attributes aren't searchable.
\nYou can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.
\nFor more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.
" + "smithy.api#documentation": "A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character. For example,\n \"family_name = \\\"Reddy\\\"\".
\n AttributeName: The name of the attribute to search for.\n You can only search for one attribute at a time.
\n\n Filter-Type: For an exact match, use =, for example,\n \"given_name = \\\"Jon\\\"\". For a prefix (\"starts with\") match, use\n ^=, for example, \"given_name ^= \\\"Jon\\\"\".
\n AttributeValue: The attribute value that must be matched\n for each user.
\nIf the filter string is empty, ListUsers returns all users in the user\n pool.
You can only search for the following standard attributes:
\n\n username (case-sensitive)
\n email\n
\n phone_number\n
\n name\n
\n given_name\n
\n family_name\n
\n preferred_username\n
\n cognito:user_status (called Status in the Console) (case-insensitive)
\n status (called Enabled in the Console)\n (case-sensitive)\n
\n sub\n
Custom attributes aren't searchable.
\nYou can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.
\nFor more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.
" } } }, @@ -11238,7 +11238,7 @@ "MaxValue": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The maximum value of an attribute that is of the number data type.
" + "smithy.api#documentation": "The maximum length of a number attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The maximum length.
" + "smithy.api#documentation": "The maximum length of a string attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.
The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The new Amazon Elastic DocumentDB service endpoint.
", + "smithy.api#documentation": "Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. \n Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.
\nAmazon DocumentDB elastic-clusters were created to:
\nprovide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.
\ngive customers higher connection limits, and to reduce downtime from patching.
\ncontinue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.
\nThe name of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The name of the elastic cluster.
", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { - "smithy.api#documentation": "The status of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The status of the elastic cluster.
", "smithy.api#required": {} } }, "clusterEndpoint": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The URL used to connect to the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The URL used to connect to the elastic cluster.
", "smithy.api#required": {} } }, "createTime": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
", + "smithy.api#documentation": "The time when the elastic cluster was created in Universal Coordinated Time (UTC).
", "smithy.api#required": {} } }, "adminUserName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the Elastic DocumentDB cluster administrator.
", + "smithy.api#documentation": "The name of the elastic cluster administrator.
", "smithy.api#required": {} } }, "authType": { "target": "com.amazonaws.docdbelastic#Auth", "traits": { - "smithy.api#documentation": "The authentication type for the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The authentication type for the elastic cluster.
", "smithy.api#required": {} } }, "shardCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The capacity of each shard in the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. \n Allowed values are 2, 4, 8, 16, 32, 64.
", "smithy.api#required": {} } }, "shardCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The number of shards in the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The number of shards assigned to the elastic cluster. Maximum is 32.
", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups associated with this cluster.
", + "smithy.api#documentation": "A list of EC2 VPC security groups associated with thie elastic cluster.
", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The Amazon EC2 subnet IDs for the elastic cluster.
", "smithy.api#required": {} } }, "preferredMaintenanceWindow": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur,\n in Universal Coordinated Time (UTC).
\n\n Format: ddd:hh24:mi-ddd:hh24:mi\n
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\n\n Format: ddd:hh24:mi-ddd:hh24:mi\n
The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The KMS key identifier to use to encrypt the elastic cluster.
", "smithy.api#required": {} } + }, + "shards": { + "target": "com.amazonaws.docdbelastic#ShardList", + "traits": { + "smithy.api#documentation": "The total number of shards in the cluster.
" + } + }, + "backupRetentionPeriod": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days for which automatic snapshots are retained.
" + } + }, + "preferredBackupWindow": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.
The number of replica instances applying to all shards in the cluster. \n A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Returns information about a specific Elastic DocumentDB cluster.
" + "smithy.api#documentation": "Returns information about a specific elastic cluster.
" } }, "com.amazonaws.docdbelastic#ClusterInList": { @@ -885,27 +918,27 @@ "clusterName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The name of the elastic cluster.
", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { - "smithy.api#documentation": "The status of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The status of the elastic cluster.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A list of Elastic DocumentDB cluster.
" + "smithy.api#documentation": "A list of Amazon DocumentDB elastic clusters.
" } }, "com.amazonaws.docdbelastic#ClusterList": { @@ -920,76 +953,82 @@ "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "A list of the IDs of subnets associated with the DB cluster snapshot.
", + "smithy.api#documentation": "The Amazon EC2 subnet IDs for the elastic cluster.
", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "The name of the elastic cluster snapshot.
", "smithy.api#required": {} } }, "snapshotArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB snapshot
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster snapshot.
", "smithy.api#required": {} } }, "snapshotCreationTime": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
", + "smithy.api#documentation": "The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster.
", "smithy.api#required": {} } }, "clusterCreationTime": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
", + "smithy.api#documentation": "The time when the elastic cluster was created in Universal Coordinated Time (UTC).
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { - "smithy.api#documentation": "The status of the Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "The status of the elastic cluster snapshot.
", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "A list of the IDs of the VPC security groups associated with the cluster snapshot.
", + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with the elastic cluster.
", "smithy.api#required": {} } }, "adminUserName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the Elastic DocumentDB cluster administrator.
", + "smithy.api#documentation": "The name of the elastic cluster administrator.
", "smithy.api#required": {} } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. \n If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.\n If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. \n Your account has a different default encryption key for each Amazon Region.\n
", "smithy.api#required": {} } + }, + "snapshotType": { + "target": "com.amazonaws.docdbelastic#SnapshotType", + "traits": { + "smithy.api#documentation": "The type of cluster snapshots to be returned. \n You can specify one of the following values:
\n\n automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
\n manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
Returns information about a specific Elastic DocumentDB snapshot.
" + "smithy.api#documentation": "Returns information about a specific elastic cluster snapshot.
" } }, "com.amazonaws.docdbelastic#ClusterSnapshotInList": { @@ -998,41 +1037,41 @@ "snapshotName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "The name of the elastic cluster snapshot.
", "smithy.api#required": {} } }, "snapshotArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB snapshot
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster snapshot.
", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { - "smithy.api#documentation": "The status of the Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "The status of the elastic cluster snapshot.
", "smithy.api#required": {} } }, "snapshotCreationTime": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
", + "smithy.api#documentation": "The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A list of Elastic DocumentDB snapshots.
" + "smithy.api#documentation": "A list of elastic cluster snapshots.
" } }, "com.amazonaws.docdbelastic#ClusterSnapshotList": { @@ -1071,6 +1110,138 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.docdbelastic#CopyClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.docdbelastic#CopyClusterSnapshotInput" + }, + "output": { + "target": "com.amazonaws.docdbelastic#CopyClusterSnapshotOutput" + }, + "errors": [ + { + "target": "com.amazonaws.docdbelastic#AccessDeniedException" + }, + { + "target": "com.amazonaws.docdbelastic#ConflictException" + }, + { + "target": "com.amazonaws.docdbelastic#InternalServerException" + }, + { + "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.docdbelastic#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.docdbelastic#ThrottlingException" + }, + { + "target": "com.amazonaws.docdbelastic#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Copies a snapshot of an elastic cluster.
", + "smithy.api#examples": [ + { + "title": "Basic Copy Cluster Snapshot Example", + "documentation": "update applied", + "input": { + "snapshotArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster-snapshot/$SOURCE_SNAPSHOT_ID", + "targetSnapshotName": "sampleSnapshotName" + }, + "output": { + "snapshot": { + "subnetIds": [ + "subnetId1", + "subnetId2" + ], + "snapshotName": "sampleSnapshotName", + "snapshotArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster-snapshot/$TARGET_SNAPSHOT_ID", + "snapshotCreationTime": "2000-01-01T00:00:00.000Z", + "clusterArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID", + "clusterCreationTime": "2000-01-01T00:00:00.000Z", + "status": "ACTIVE", + "vpcSecurityGroupIds": [ + "vpcSgId1, vpcSgId2" + ], + "adminUserName": "sampleAdminUser", + "kmsKeyId": "AWS_OWNED_KMS_KEY", + "snapshotType": "MANUAL" + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cluster-snapshot/{snapshotArn}/copy" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.docdbelastic#CopyClusterSnapshotInput": { + "type": "structure", + "members": { + "snapshotArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "snapshotArn" + } + }, + "targetSnapshotName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. \n This parameter is not case sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: elastic-cluster-snapshot-5\n
The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. \n The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.
\nIf you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. \n If you don't specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the source elastic cluster snapshot.
To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. \n Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.
If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. \n The default is false.
The tags to be assigned to the elastic cluster snapshot.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.docdbelastic#CopyClusterSnapshotOutput": { + "type": "structure", + "members": { + "snapshot": { + "target": "com.amazonaws.docdbelastic#ClusterSnapshot", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.docdbelastic#CreateCluster": { "type": "operation", "input": { @@ -1100,7 +1271,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
", + "smithy.api#documentation": "Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1115,67 +1286,67 @@ "clusterName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the new Elastic DocumentDB cluster. This parameter is stored as\n a lowercase string.
\n\n Constraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\n\n Example: my-cluster\n
The name of the new elastic cluster. This parameter is stored as\n a lowercase string.
\n\n Constraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\n\n Example: my-cluster\n
The authentication type for the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The authentication type used to determine where to fetch the password used for accessing the elastic cluster. \n Valid types are PLAIN_TEXT or SECRET_ARN.
The name of the Elastic DocumentDB cluster administrator.
\n\n Constraints:
\nMust be from 1 to 63 letters or numbers.
\nThe first character must be a letter.
\nCannot be a reserved word.
\nThe name of the Amazon DocumentDB elastic clusters administrator.
\n\n Constraints:
\nMust be from 1 to 63 letters or numbers.
\nThe first character must be a letter.
\nCannot be a reserved word.
\nThe password for the Elastic DocumentDB cluster administrator and can\n contain any printable ASCII characters.
\n\n Constraints:
\nMust contain from 8 to 100 characters.
\nCannot contain a forward slash (/), double quote (\"), or the \"at\" symbol (@).
\nThe password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
\n\n Constraints:
\nMust contain from 8 to 100 characters.
\nCannot contain a forward slash (/), double quote (\"), or the \"at\" symbol (@).
\nThe capacity of each shard in the new Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
", "smithy.api#required": {} } }, "shardCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The number of shards to create in the new Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The number of shards assigned to the elastic cluster. Maximum is 32.
", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups to associate with the new\n Elastic DocumentDB cluster.
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with the new\n elastic cluster.
" } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
" + "smithy.api#documentation": "The Amazon EC2 subnet IDs for the new elastic cluster.
" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS\n encryption key. If you are creating a cluster using the same Amazon account\n that owns this KMS encryption key, you can use the KMS key alias instead\n of the ARN as the KMS encryption key.
\nIf an encryption key is not specified, Elastic DocumentDB uses the\n default encryption key that KMS creates for your account. Your account\n has a different default encryption key for each Amazon Region.
" + "smithy.api#documentation": "The KMS key identifier to use to encrypt the new elastic cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS\n encryption key. If you are creating a cluster using the same Amazon account\n that owns this KMS encryption key, you can use the KMS key alias instead\n of the ARN as the KMS encryption key.
\nIf an encryption key is not specified, Amazon DocumentDB uses the\n default encryption key that KMS creates for your account. Your account\n has a different default encryption key for each Amazon Region.
" } }, "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The client token for the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The client token for the elastic cluster.
", "smithy.api#idempotencyToken": {} } }, @@ -1188,7 +1359,25 @@ "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { - "smithy.api#documentation": "The tags to be assigned to the new Elastic DocumentDB cluster.
" + "smithy.api#documentation": "The tags to be assigned to the new elastic cluster.
" + } + }, + "backupRetentionPeriod": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days for which automatic snapshots are retained.
" + } + }, + "preferredBackupWindow": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
The number of replica instances applying to all shards in the elastic cluster. \n A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
The new Elastic DocumentDB cluster that has been created.
", + "smithy.api#documentation": "The new elastic cluster that has been created.
", "smithy.api#required": {} } } @@ -1237,7 +1426,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a snapshot of a cluster.
", + "smithy.api#documentation": "Creates a snapshot of an elastic cluster.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1252,14 +1441,14 @@ "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster of which you want to create a snapshot.
", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "The name of the new elastic cluster snapshot.
", "smithy.api#length": { "min": 1, "max": 63 @@ -1270,7 +1459,7 @@ "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { - "smithy.api#documentation": "The tags to be assigned to the new Elastic DocumentDB snapshot.
" + "smithy.api#documentation": "The tags to be assigned to the new elastic cluster snapshot.
" } } } @@ -1281,7 +1470,7 @@ "snapshot": { "target": "com.amazonaws.docdbelastic#ClusterSnapshot", "traits": { - "smithy.api#documentation": "Returns information about the new Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "Returns information about the new elastic cluster snapshot.
", "smithy.api#required": {} } } @@ -1316,7 +1505,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete a Elastic DocumentDB cluster.
", + "smithy.api#documentation": "Delete an elastic cluster.
", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -1331,7 +1520,7 @@ "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster that is to be deleted.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster that is to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" @@ -1345,7 +1534,7 @@ "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { - "smithy.api#documentation": "Returns information about the newly deleted Elastic DocumentDB cluster.
", + "smithy.api#documentation": "Returns information about the newly deleted elastic cluster.
", "smithy.api#required": {} } } @@ -1380,7 +1569,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete a Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "Delete an elastic cluster snapshot.
", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -1395,7 +1584,7 @@ "snapshotArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB snapshot that is to be deleted.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster snapshot that is to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "snapshotArn" @@ -1409,7 +1598,7 @@ "snapshot": { "target": "com.amazonaws.docdbelastic#ClusterSnapshot", "traits": { - "smithy.api#documentation": "Returns information about the newly deleted Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "Returns information about the newly deleted elastic cluster snapshot.
", "smithy.api#required": {} } } @@ -1441,7 +1630,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a specific Elastic DocumentDB cluster.
", + "smithy.api#documentation": "Returns information about a specific elastic cluster.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -1456,7 +1645,7 @@ "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" @@ -1470,7 +1659,7 @@ "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { - "smithy.api#documentation": "Returns information about a specific Elastic DocumentDB cluster.
", + "smithy.api#documentation": "Returns information about a specific elastic cluster.
", "smithy.api#required": {} } } @@ -1502,7 +1691,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a specific Elastic DocumentDB snapshot
", + "smithy.api#documentation": "Returns information about a specific elastic cluster snapshot
", "smithy.api#http": { "code": 200, "method": "GET", @@ -1517,7 +1706,7 @@ "snapshotArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster snapshot.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "snapshotArn" @@ -1531,7 +1720,7 @@ "snapshot": { "target": "com.amazonaws.docdbelastic#ClusterSnapshot", "traits": { - "smithy.api#documentation": "Returns information about a specific Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "Returns information about a specific elastic cluster snapshot.
", "smithy.api#required": {} } } @@ -1577,7 +1766,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about Elastic DocumentDB snapshots for a specified cluster.
", + "smithy.api#documentation": "Returns information about snapshots for a specified elastic cluster.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -1598,14 +1787,14 @@ "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster.
", "smithy.api#httpQuery": "clusterArn" } }, "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { - "smithy.api#documentation": "The nextToken which is used the get the next page of data.
", + "smithy.api#documentation": "A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
The maximum number of entries to recieve in the response.
", + "smithy.api#documentation": "The maximum number of elastic cluster snapshot results to receive in the response.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 20, "max": 100 } } + }, + "snapshotType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of cluster snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
\n manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
A list of Elastic DocumentDB snapshots for a specified cluster.
" + "smithy.api#documentation": "A list of snapshots for a specified elastic cluster.
" } }, "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { - "smithy.api#documentation": "The response will provide a nextToken if there is more data beyond the maxResults.
\nIf there is no more data in the responce, the nextToken will not be returned.
" + "smithy.api#documentation": "A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
Returns information about provisioned Elastic DocumentDB clusters.
", + "smithy.api#documentation": "Returns information about provisioned Amazon DocumentDB elastic clusters.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -1684,7 +1880,7 @@ "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { - "smithy.api#documentation": "The nextToken which is used the get the next page of data.
", + "smithy.api#documentation": "A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
The maximum number of entries to recieve in the response.
", + "smithy.api#documentation": "The maximum number of elastic cluster snapshot results to receive in the response.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -1708,13 +1904,13 @@ "clusters": { "target": "com.amazonaws.docdbelastic#ClusterList", "traits": { - "smithy.api#documentation": "A list of Elastic DocumentDB cluster.
" + "smithy.api#documentation": "A list of Amazon DocumentDB elastic clusters.
" } }, "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { - "smithy.api#documentation": "The response will provide a nextToken if there is more data beyond the maxResults.
\nIf there is no more data in the responce, the nextToken will not be returned.
" + "smithy.api#documentation": "A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
Lists all tags on a Elastic DocumentDB resource
", + "smithy.api#documentation": "Lists all tags on a elastic cluster resource
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "GET" @@ -1756,7 +1952,7 @@ "resourceArn": { "target": "com.amazonaws.docdbelastic#Arn", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB resource.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1769,7 +1965,7 @@ "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { - "smithy.api#documentation": "The list of tags for the specified Elastic DocumentDB resource.
" + "smithy.api#documentation": "The list of tags for the specified elastic cluster resource.
" } } } @@ -1849,7 +2045,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores a Elastic DocumentDB cluster from a snapshot.
", + "smithy.api#documentation": "Restores an elastic cluster from a snapshot.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1864,14 +2060,14 @@ "clusterName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The name of the elastic cluster.
", "smithy.api#required": {} } }, "snapshotArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB snapshot.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster snapshot.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "snapshotArn" @@ -1880,25 +2076,37 @@ "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups to associate with the\n Elastic DocumentDB cluster.
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with the elastic cluster.
" } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
" + "smithy.api#documentation": "The Amazon EC2 subnet IDs for the elastic cluster.
" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS\n encryption key. If you are creating a cluster using the same Amazon account\n that owns this KMS encryption key, you can use the KMS key alias instead\n of the ARN as the KMS encryption key.
\nIf an encryption key is not specified here, Elastic DocumentDB uses the\n default encryption key that KMS creates for your account. Your account\n has a different default encryption key for each Amazon Region.
" + "smithy.api#documentation": "The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS\n encryption key. If you are creating a cluster using the same Amazon account\n that owns this KMS encryption key, you can use the KMS key alias instead\n of the ARN as the KMS encryption key.
\nIf an encryption key is not specified here, Amazon DocumentDB uses the\n default encryption key that KMS creates for your account. Your account\n has a different default encryption key for each Amazon Region.
" } }, "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { - "smithy.api#documentation": "A list of the tag names to be assigned to the restored DB cluster,\n in the form of an array of key-value pairs in which the key\n is the tag name and the value is the key value.
" + "smithy.api#documentation": "A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
" + } + }, + "shardCapacity": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The capacity of each shard in the new restored elastic cluster.
" + } + }, + "shardInstanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of replica instances applying to all shards in the elastic cluster. \n A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Returns information about a the restored Elastic DocumentDB cluster.
", + "smithy.api#documentation": "Returns information about a the restored elastic cluster.
", "smithy.api#required": {} } } @@ -1931,6 +2139,157 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.docdbelastic#Shard": { + "type": "structure", + "members": { + "shardId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the shard.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The time when the shard was created in Universal Coordinated Time (UTC).
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.docdbelastic#Status", + "traits": { + "smithy.api#documentation": "The current status of the shard.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The name of the shard.
" + } + }, + "com.amazonaws.docdbelastic#ShardList": { + "type": "list", + "member": { + "target": "com.amazonaws.docdbelastic#Shard" + } + }, + "com.amazonaws.docdbelastic#SnapshotType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MANUAL", + "name": "MANUAL" + }, + { + "value": "AUTOMATED", + "name": "AUTOMATED" + } + ] + } + }, + "com.amazonaws.docdbelastic#StartCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.docdbelastic#StartClusterInput" + }, + "output": { + "target": "com.amazonaws.docdbelastic#StartClusterOutput" + }, + "errors": [ + { + "target": "com.amazonaws.docdbelastic#AccessDeniedException" + }, + { + "target": "com.amazonaws.docdbelastic#InternalServerException" + }, + { + "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.docdbelastic#ThrottlingException" + }, + { + "target": "com.amazonaws.docdbelastic#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Restarts the stopped elastic cluster that is specified by clusterARN.
The ARN identifier of the elastic cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "clusterArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.docdbelastic#StartClusterOutput": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.docdbelastic#Cluster", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.docdbelastic#Status": { "type": "string", "traits": { @@ -1970,10 +2329,151 @@ { "value": "INACCESSIBLE_ENCRYPTION_CREDS", "name": "INACCESSIBLE_ENCRYPTION_CREDS" + }, + { + "value": "INACCESSIBLE_SECRET_ARN", + "name": "INACCESSIBLE_SECRET_ARN" + }, + { + "value": "INACCESSIBLE_VPC_ENDPOINT", + "name": "INACCESSIBLE_VPC_ENDPOINT" + }, + { + "value": "INCOMPATIBLE_NETWORK", + "name": "INCOMPATIBLE_NETWORK" + }, + { + "value": "MERGING", + "name": "MERGING" + }, + { + "value": "MODIFYING", + "name": "MODIFYING" + }, + { + "value": "SPLITTING", + "name": "SPLITTING" + }, + { + "value": "COPYING", + "name": "COPYING" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" } ] } }, + "com.amazonaws.docdbelastic#StopCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.docdbelastic#StopClusterInput" + }, + "output": { + "target": "com.amazonaws.docdbelastic#StopClusterOutput" + }, + "errors": [ + { + "target": "com.amazonaws.docdbelastic#AccessDeniedException" + }, + { + "target": "com.amazonaws.docdbelastic#InternalServerException" + }, + { + "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.docdbelastic#ThrottlingException" + }, + { + "target": "com.amazonaws.docdbelastic#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops the running elastic cluster that is specified by clusterArn. \n The elastic cluster must be in the available state.
The ARN identifier of the elastic cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "clusterArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.docdbelastic#StopClusterOutput": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.docdbelastic#Cluster", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.docdbelastic#StringList": { "type": "list", "member": { @@ -2034,7 +2534,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds metadata tags to a Elastic DocumentDB resource
", + "smithy.api#documentation": "Adds metadata tags to an elastic cluster resource
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST" @@ -2047,7 +2547,7 @@ "resourceArn": { "target": "com.amazonaws.docdbelastic#Arn", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB resource.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2055,7 +2555,7 @@ "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { - "smithy.api#documentation": "The tags to be assigned to the Elastic DocumentDB resource.
", + "smithy.api#documentation": "The tags that are assigned to the elastic cluster resource.
", "smithy.api#required": {} } } @@ -2121,7 +2621,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes metadata tags to a Elastic DocumentDB resource
", + "smithy.api#documentation": "Removes metadata tags from an elastic cluster resource
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "DELETE" @@ -2135,7 +2635,7 @@ "resourceArn": { "target": "com.amazonaws.docdbelastic#Arn", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB resource.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2143,7 +2643,7 @@ "tagKeys": { "target": "com.amazonaws.docdbelastic#TagKeyList", "traits": { - "smithy.api#documentation": "The tag keys to be removed from the Elastic DocumentDB resource.
", + "smithy.api#documentation": "The tag keys to be removed from the elastic cluster resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -2183,7 +2683,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, \n upgrading API version setting up a backup window and maintenance window
", + "smithy.api#documentation": "Modifies an elastic cluster. This includes updating admin-username/password, \n upgrading the API version, and setting up a backup window and maintenance window
", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2198,7 +2698,7 @@ "clusterArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The arn of the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The ARN identifier of the elastic cluster.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" @@ -2207,50 +2707,68 @@ "authType": { "target": "com.amazonaws.docdbelastic#Auth", "traits": { - "smithy.api#documentation": "The authentication type for the Elastic DocumentDB cluster.
" + "smithy.api#documentation": "The authentication type used to determine where to fetch the password used for accessing the elastic cluster. \n Valid types are PLAIN_TEXT or SECRET_ARN.
The capacity of each shard in the Elastic DocumentDB cluster.
" + "smithy.api#documentation": "The number of vCPUs assigned to each elastic cluster shard. \n Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
" } }, "shardCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The number of shards to create in the Elastic DocumentDB cluster.
" + "smithy.api#documentation": "The number of shards assigned to the elastic cluster. Maximum is 32.
" } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups to associate with the new\n Elastic DocumentDB cluster.
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with the elastic cluster.
" } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { - "smithy.api#documentation": "The number of shards to create in the Elastic DocumentDB cluster.
" + "smithy.api#documentation": "The Amazon EC2 subnet IDs for the elastic cluster.
" } }, "adminUserPassword": { "target": "com.amazonaws.docdbelastic#Password", "traits": { - "smithy.api#documentation": "The password for the Elastic DocumentDB cluster administrator. This password can\n contain any printable ASCII character except forward slash (/),\n double quote (\"), or the \"at\" symbol (@).
\n\n Constraints: Must contain from 8 to 100 characters.
" + "smithy.api#documentation": "The password associated with the elastic cluster administrator. \n This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).
\n\n Constraints: Must contain from 8 to 100 characters.
" } }, "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The client token for the Elastic DocumentDB cluster.
", + "smithy.api#documentation": "The client token for the elastic cluster.
", "smithy.api#idempotencyToken": {} } }, "preferredMaintenanceWindow": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur,\n in Universal Coordinated Time (UTC).
\n\n Format: ddd:hh24:mi-ddd:hh24:mi\n
\n Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
\n\n Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\n\n Constraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\n\n Format: ddd:hh24:mi-ddd:hh24:mi\n
\n Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
\n\n Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\n\n Constraints: Minimum 30-minute window.
" + } + }, + "backupRetentionPeriod": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days for which automatic snapshots are retained.
" + } + }, + "preferredBackupWindow": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
The number of replica instances applying to all shards in the elastic cluster. \n A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Returns information about the updated Elastic DocumentDB cluster.
", + "smithy.api#documentation": "Returns information about the updated elastic cluster.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json index b9f38b80d5d..fcdf40df0b7 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -117,7 +117,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents an attribute for describing the key schema for the table and\n indexes.
" + "smithy.api#documentation": "Represents an attribute for describing the schema for the table and\n indexes.
" } }, "com.amazonaws.dynamodb#AttributeDefinitions": { @@ -5471,7 +5471,7 @@ "S3BucketOwner": { "target": "com.amazonaws.dynamodb#S3BucketOwner", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.
\nS3BucketOwner is a required parameter when exporting to a S3 bucket in another account.
\nThe set of attributes that are projected into the index:
\n\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - In addition to the attributes described in\n KEYS_ONLY, the secondary index will include other non-key\n attributes that you specify.
\n ALL - All of the table attributes are projected into the\n index.
The set of attributes that are projected into the index:
\n\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - In addition to the attributes described in\n KEYS_ONLY, the secondary index will include other non-key\n attributes that you specify.
\n ALL - All of the table attributes are projected into the\n index.
When using the DynamoDB console, ALL is selected by default.
A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "KeyConditionExpression": { @@ -11461,7 +11461,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.
\nThis operation only applies to Version\n 2017.11.29 (Legacy) of global tables. We recommend using\n Version 2019.11.21 (Current)\n when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than \n 2017.11.29 (Legacy). To determine which version you are using, see \n Determining the version. \n To update existing global tables from version 2017.11.29 (Legacy) to version\n 2019.11.21 (Current), see \n Updating global tables.\n
\n\n This operation only applies to Version\n 2017.11.29 of global tables. If you are using global tables Version\n 2019.11.21 you can use DescribeTable instead.\n
\n\n Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.\n
If global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nThe global secondary indexes must have the same provisioned and maximum write\n capacity units.
\nAdds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.
\nThis operation only applies to Version\n 2017.11.29 (Legacy) of global tables. We recommend using\n Version 2019.11.21 (Current)\n when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than \n 2017.11.29 (Legacy). To determine which version you are using, see \n Determining the version. \n To update existing global tables from version 2017.11.29 (Legacy) to version\n 2019.11.21 (Current), see \n Updating global tables.\n
\n\n This operation only applies to Version\n 2017.11.29 of global tables. If you are using global tables Version\n 2019.11.21 you can use UpdateTable instead.\n
\n\n Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.\n
If global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nThe global secondary indexes must have the same provisioned and maximum write\n capacity units.
\nBundles an Amazon instance store-backed Windows instance.
\nDuring bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.
\nThis action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
\nBundles an Amazon instance store-backed Windows instance.
\nDuring bundling, only the root device volume (C:\\) is bundled. Data on other instance\n store volumes is not preserved.
\nThis action is not applicable for Linux/Unix instances or Windows instances that are\n backed by Amazon EBS.
\nThe ID of the instance to bundle.
\nType: String
\nDefault: None
\nRequired: Yes
", + "smithy.api#documentation": "The ID of the instance to bundle.
\nDefault: None
", "smithy.api#required": {} } }, @@ -9233,7 +9233,7 @@ "target": "com.amazonaws.ec2#Storage", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
", + "smithy.api#documentation": "The bucket in which to store the AMI. You can specify a bucket that you already own or a\n new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone\n else, Amazon EC2 returns an error.
", "smithy.api#required": {} } }, @@ -9920,7 +9920,7 @@ "target": "com.amazonaws.ec2#CancelImageLaunchPermissionResult" }, "traits": { - "smithy.api#documentation": "Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more\n information, see \n Cancel having an AMI shared with your Amazon Web Services account in the \n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Removes your Amazon Web Services account from the launch permissions for the specified AMI.\n For more information, see Cancel having an AMI shared with\n your Amazon Web Services account in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CancelImageLaunchPermissionRequest": { @@ -13481,7 +13481,7 @@ "target": "com.amazonaws.ec2#CopyImageResult" }, "traits": { - "smithy.api#documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\nTo copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
\nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to\n another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\nTo copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its\n endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of\n unencrypted backing snapshots remain unencrypted, unless you set Encrypted during\n the copy operation. You cannot create an unencrypted copy of an encrypted backing\n snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination\n Outpost using DestinationOutpostArn. Backing snapshots copied\n to an Outpost are encrypted by default using the default encryption key for the Region, or a\n different key that you specify in the request using KmsKeyId.\n Outposts do not support unencrypted snapshots. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EC2 User Guide.
\nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To copy an AMI to another region", @@ -13505,7 +13505,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
" + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For\n more information, see Ensuring idempotency\n in the Amazon EC2 API Reference.
" } }, "Description": { @@ -13526,7 +13526,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating\n \t\tencrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. \n \t\tIf you specify a KMS key, you must also set the encrypted state to true.
You can specify a KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid,\n the action can appear to complete, but eventually fails.
\nThe specified KMS key must exist in the destination Region.
\nAmazon EBS does not support asymmetric KMS keys.
", + "smithy.api#documentation": "The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes.\n If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you\n specify a KMS key, you must also set the encrypted state to true.
You can specify a KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier\n that is not valid, the action can appear to complete, but eventually fails.
\nThe specified KMS key must exist in the destination Region.
\nAmazon EBS does not support asymmetric KMS keys.
", "smithy.api#xmlName": "kmsKeyId" } }, @@ -13557,7 +13557,7 @@ "DestinationOutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.
\nFor more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this\n parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the\n Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from\n one Outpost to another, or within the same Outpost.
\nFor more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon EC2 User Guide.
" } }, "DryRun": { @@ -13571,7 +13571,14 @@ "CopyImageTags": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether to include your user-defined AMI tags when copying the AMI.
\nThe following tags will not be copied:
\nSystem tags (prefixed with aws:)
For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services \n accounts
\nDefault: Your user-defined AMI tags are not copied.
" + "smithy.api#documentation": "Indicates whether to include your user-defined AMI tags when copying the AMI.
\nThe following tags will not be copied:
\nSystem tags (prefixed with aws:)
For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services\n accounts
\nDefault: Your user-defined AMI tags are not copied.
" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or\n both.
\nTo tag the new AMI, the value for ResourceType must be\n image.
To tag the new snapshots, the value for ResourceType must be\n snapshot. The same tag is applied to all the new snapshots.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", + "smithy.api#xmlName": "TagSpecification" } } }, @@ -15464,7 +15471,7 @@ "target": "com.amazonaws.ec2#CreateImageResult" }, "traits": { - "smithy.api#documentation": "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.
\nIf you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.
\nFor more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or\n stopped.
\nIf you customized your instance with instance store volumes or Amazon EBS volumes in addition\n to the root device volume, the new AMI contains block device mapping information for those\n volumes. When you launch an instance from this new AMI, the instance automatically launches\n with those additional volumes.
\nFor more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateImageRequest": { @@ -15509,7 +15516,7 @@ "traits": { "aws.protocols#ec2QueryName": "Name", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A name for the new image.
\nConstraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", + "smithy.api#documentation": "A name for the new image.
\nConstraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces\n ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or\n underscores(_)
", "smithy.api#required": {}, "smithy.api#xmlName": "name" } @@ -15518,14 +15525,14 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "NoReboot", - "smithy.api#documentation": "Indicates whether or not the instance should be automatically rebooted before creating \n the image. Specify one of the following values:
\n\n true - The instance is not rebooted before creating the image. This \n creates crash-consistent snapshots that include only the data that has been written \n to the volumes at the time the snapshots are created. Buffered data and data in \n memory that has not yet been written to the volumes is not included in the snapshots.
\n false - The instance is rebooted before creating the image. This \n ensures that all buffered data and data in memory is written to the volumes before the \n snapshots are created.
Default: false\n
Indicates whether or not the instance should be automatically rebooted before creating the\n image. Specify one of the following values:
\n\n true - The instance is not rebooted before creating the image. This\n creates crash-consistent snapshots that include only the data that has been written to the\n volumes at the time the snapshots are created. Buffered data and data in memory that has\n not yet been written to the volumes is not included in the snapshots.
\n false - The instance is rebooted before creating the image. This ensures\n that all buffered data and data in memory is written to the volumes before the snapshots\n are created.
Default: false\n
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.
\nTo tag the AMI, the value for ResourceType must be\n image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that\n are attached to the instance, the value for ResourceType must be\n snapshot. The same tag is applied to all of the snapshots that are\n created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", + "smithy.api#documentation": "The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.
\nTo tag the AMI, the value for ResourceType must be\n image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes\n that are attached to the instance, the value for ResourceType must be\n snapshot. The same tag is applied to all of the snapshots that are\n created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", "smithy.api#xmlName": "TagSpecification" } } @@ -18004,7 +18011,7 @@ "target": "com.amazonaws.ec2#CreateRestoreImageTaskResult" }, "traits": { - "smithy.api#documentation": "Starts a task that restores an AMI from an Amazon S3 object that was previously created by using\n CreateStoreImageTask.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Starts a task that restores an AMI from an Amazon S3 object that was previously created by\n using CreateStoreImageTask.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateRestoreImageTaskRequest": { @@ -18035,7 +18042,7 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the\n snapshots, or both.
\nTo tag the AMI, the value for ResourceType must be image.
To\n tag the snapshots, the value for ResourceType must be snapshot. The\n same tag is applied to all of the snapshots that are created.
The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the\n snapshots, or both.
\nTo tag the AMI, the value for ResourceType must be\n image.
To tag the snapshots, the value for ResourceType must be\n snapshot. The same tag is applied to all of the snapshots that are\n created.
Stores an AMI as a single object in an Amazon S3 bucket.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Stores an AMI as a single object in an Amazon S3 bucket.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateStoreImageTaskRequest": { @@ -26527,7 +26534,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.
\nIf you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.
\nWhen you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.
\nWhen you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.
" + "smithy.api#documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new\n instances.
\nIf you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in\n the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.
\nWhen you deregister an AMI, it doesn't affect any instances that you've already launched\n from the AMI. You'll continue to incur usage costs for those instances until you terminate\n them.
\nWhen you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created\n for the root volume of the instance during the AMI creation process. When you deregister an\n instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you\n created the AMI.
" } }, "com.amazonaws.ec2#DeregisterImageRequest": { @@ -27377,7 +27384,7 @@ "target": "com.amazonaws.ec2#DescribeBundleTasksResult" }, "traits": { - "smithy.api#documentation": "Describes the specified bundle tasks or all of your bundle tasks.
\nCompleted bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
Describes the specified bundle tasks or all of your bundle tasks.
\nCompleted bundle tasks are listed for only a limited time. If your bundle task is no\n longer in the list, you can still register an AMI from it. Just use\n RegisterImage with the Amazon S3 bucket name and image manifest name you provided\n to the bundle task.
The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nThe filters.
\n\n bundle-id - The ID of the bundle task.
\n error-code - If the task failed, the error code returned.
\n error-message - If the task failed, the error message returned.
\n instance-id - The ID of the instance.
\n progress - The level of task completion, as a percentage (for example, 20%).
\n s3-bucket - The Amazon S3 bucket to store the AMI.
\n s3-prefix - The beginning of the AMI name.
\n start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
\n state - The state of the task (pending | waiting-for-shutdown | bundling |\n storing | cancelling | complete | failed).
\n update-time - The time of the most recent update for the task.
The filters.
\n\n bundle-id - The ID of the bundle task.
\n error-code - If the task failed, the error code returned.
\n error-message - If the task failed, the error message returned.
\n instance-id - The ID of the instance.
\n progress - The level of task completion, as a percentage (for example,\n 20%).
\n s3-bucket - The Amazon S3 bucket to store the AMI.
\n s3-prefix - The beginning of the AMI name.
\n start-time - The time the task started (for example,\n 2013-09-15T17:15:20.000Z).
\n state - The state of the task (pending |\n waiting-for-shutdown | bundling | storing |\n cancelling | complete | failed).
\n update-time - The time of the most recent update for the task.
Describes Capacity Block offerings available for purchase. With Capacity Blocks, you purchase a specific instance type for a period of time.
", + "smithy.api#documentation": "Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29356,7 +29363,7 @@ "target": "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessSet", "traits": { "aws.protocols#ec2QueryName": "FastLaunchImageSet", - "smithy.api#documentation": "A collection of details about the fast-launch enabled Windows images that meet \n\t\t\tthe requested criteria.
", + "smithy.api#documentation": "A collection of details about the fast-launch enabled Windows images that meet the\n requested criteria.
", "smithy.api#xmlName": "fastLaunchImageSet" } }, @@ -29388,7 +29395,7 @@ "target": "com.amazonaws.ec2#FastLaunchResourceType", "traits": { "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values \n\t\t\tinclude: snapshot.
The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values\n include: snapshot.
A group of parameters that are used for pre-provisioning the associated \n\t\t\tWindows AMI using snapshots.
", + "smithy.api#documentation": "A group of parameters that are used for pre-provisioning the associated Windows AMI using\n snapshots.
", "smithy.api#xmlName": "snapshotConfiguration" } }, @@ -29404,7 +29411,7 @@ "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "The launch template that the Windows fast launch enabled AMI uses when it launches \n\t\t\tWindows instances from pre-provisioned snapshots.
", + "smithy.api#documentation": "The launch template that the Windows fast launch enabled AMI uses when it launches Windows\n instances from pre-provisioned snapshots.
", "smithy.api#xmlName": "launchTemplate" } }, @@ -29412,7 +29419,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MaxParallelLaunches", - "smithy.api#documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create \n\t\t\tpre-provisioned snapshots for Windows fast launch.
", + "smithy.api#documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch.
", "smithy.api#xmlName": "maxParallelLaunches" } }, @@ -29450,7 +29457,7 @@ } }, "traits": { - "smithy.api#documentation": "Describe details about a Windows image with Windows fast launch enabled that meets the requested \n\t\t\tcriteria. Criteria are defined by the DescribeFastLaunchImages action filters.
Describe details about a Windows image with Windows fast launch enabled that meets the\n requested criteria. Criteria are defined by the DescribeFastLaunchImages action\n filters.
Describes the running instances for the specified EC2 Fleet.
\nFor more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Describes the running instances for the specified EC2 Fleet.
\nCurrently, DescribeFleetInstances does not support fleets of type\n instant. Instead, use DescribeFleets, specifying the\n instant fleet ID in the request.
For more information, see Describe your\n EC2 Fleet in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DescribeFleetInstancesRequest": { @@ -29893,7 +29900,7 @@ "target": "com.amazonaws.ec2#DescribeFleetsResult" }, "traits": { - "smithy.api#documentation": "Describes the specified EC2 Fleets or all of your EC2 Fleets.
\nFor more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes the specified EC2 Fleet or all of your EC2 Fleets.
\nIf a fleet is of type instant, you must specify the fleet ID in the\n request, otherwise the fleet does not appear in the response.
For more information, see Describe your\n EC2 Fleet in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -30734,7 +30741,7 @@ "target": "com.amazonaws.ec2#ImageAttribute" }, "traits": { - "smithy.api#documentation": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
", + "smithy.api#documentation": "Describes the specified attribute of the specified AMI. You can specify only one attribute\n at a time.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nThe AMI attribute.
\n\n Note: The blockDeviceMapping attribute is deprecated. \n \t Using this attribute returns the Client.AuthFailure error. To get information about \n \t the block device mappings for an AMI, use the DescribeImages action.
The AMI attribute.
\n\n Note: The blockDeviceMapping attribute is\n deprecated. Using this attribute returns the Client.AuthFailure error. To get\n information about the block device mappings for an AMI, use the DescribeImages action.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
\nThe images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
", + "smithy.api#documentation": "Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the\n images available to you.
\nThe images available to you include public images, private images that you own, and\n private images owned by other Amazon Web Services accounts for which you have explicit launch\n permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nScopes the images by users with explicit launch permissions. \n Specify an Amazon Web Services account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs\n shared with that specific Amazon Web Services account ID are returned. However, AMIs that\n are shared with the account’s organization or organizational unit (OU) are not\n returned.
\nIf you specify self or your own Amazon Web Services account ID, AMIs\n shared with your account are returned. In addition, AMIs that are shared with the\n organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all\n (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared\n with that specific Amazon Web Services account ID are returned. However, AMIs that are\n shared with the account’s organization or organizational unit (OU) are not\n returned.
\nIf you specify self or your own Amazon Web Services account ID, AMIs\n shared with your account are returned. In addition, AMIs that are shared with the\n organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
\n\n architecture - The image architecture (i386 | x86_64 | \n arm64 | x86_64_mac | arm64_mac).
\n block-device-mapping.delete-on-termination - A Boolean value that indicates\n \twhether the Amazon EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in the block device mapping (for\n example, /dev/sdh or xvdh).
\n block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS\n volume.
\n block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
\n block-device-mapping.volume-type - The volume type of the Amazon EBS volume\n (io1 | io2 | gp2 | gp3 | sc1\n | st1 | standard).
\n block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
\n creation-date - The time when the image was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2021-09-29T*, which matches an entire day.
\n description - The description of the image (provided during image\n creation).
\n ena-support - A Boolean that indicates whether enhanced networking\n with ENA is enabled.
\n hypervisor - The hypervisor type (ovm |\n xen).
\n image-id - The ID of the image.
\n image-type - The image type (machine | kernel |\n ramdisk).
\n is-public - A Boolean that indicates whether the image is public.
\n kernel-id - The kernel ID.
\n manifest-location - The location of the image manifest.
\n name - The name of the AMI (provided during image creation).
\n owner-alias - The owner alias (amazon | aws-marketplace). \n The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be \n \tset using the IAM console. We recommend that you use the Owner \n \trequest parameter instead of this filter.
\n owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the \n \t\tOwner request parameter instead of this filter.
\n platform - The platform. The only supported value is windows.
\n product-code - The product code.
\n product-code.type - The type of the product code (marketplace).
\n ramdisk-id - The RAM disk ID.
\n root-device-name - The device name of the root device volume (for example, /dev/sda1).
\n root-device-type - The type of the root device volume (ebs |\n instance-store).
\n source-instance-id - The ID of the instance that the AMI was created from\n if the AMI was created using CreateImage. This filter is applicable only if the AMI was\n created using CreateImage.
\n state - The state of the image (available | pending\n | failed).
\n state-reason-code - The reason code for the state change.
\n state-reason-message - The message for the state change.
\n sriov-net-support - A value of simple indicates\n that enhanced networking with the Intel 82599 VF interface is enabled.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n virtualization-type - The virtualization type (paravirtual |\n hvm).
The filters.
\n\n architecture - The image architecture (i386 |\n x86_64 | arm64 | x86_64_mac |\n arm64_mac).
\n block-device-mapping.delete-on-termination - A Boolean value that indicates\n whether the Amazon EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in the block\n device mapping (for example, /dev/sdh or xvdh).
\n block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS\n volume.
\n block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in\n GiB.
\n block-device-mapping.volume-type - The volume type of the Amazon EBS volume\n (io1 | io2 | gp2 | gp3 | sc1\n | st1 | standard).
\n block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS\n volume is encrypted.
\n creation-date - The time when the image was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2021-09-29T*, which matches an entire day.
\n description - The description of the image (provided during image\n creation).
\n ena-support - A Boolean that indicates whether enhanced networking with\n ENA is enabled.
\n hypervisor - The hypervisor type (ovm |\n xen).
\n image-id - The ID of the image.
\n image-type - The image type (machine | kernel |\n ramdisk).
\n is-public - A Boolean that indicates whether the image is public.
\n kernel-id - The kernel ID.
\n manifest-location - The location of the image manifest.
\n name - The name of the AMI (provided during image creation).
\n owner-alias - The owner alias (amazon |\n aws-marketplace). The valid aliases are defined in an Amazon-maintained\n list. This is not the Amazon Web Services account alias that can be set using the IAM\n console. We recommend that you use the Owner request\n parameter instead of this filter.
\n owner-id - The Amazon Web Services account ID of the owner. We recommend\n that you use the Owner request parameter instead of this\n filter.
\n platform - The platform. The only supported value is\n windows.
\n product-code - The product code.
\n product-code.type - The type of the product code\n (marketplace).
\n ramdisk-id - The RAM disk ID.
\n root-device-name - The device name of the root device volume (for example,\n /dev/sda1).
\n root-device-type - The type of the root device volume (ebs |\n instance-store).
\n source-instance-id - The ID of the instance that the AMI was created from\n if the AMI was created using CreateImage. This filter is applicable only if the AMI was\n created using CreateImage.
\n state - The state of the image (available | pending\n | failed).
\n state-reason-code - The reason code for the state change.
\n state-reason-message - The message for the state change.
\n sriov-net-support - A value of simple indicates that\n enhanced networking with the Intel 82599 VF interface is enabled.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n virtualization-type - The virtualization type (paravirtual |\n hvm).
Scopes the results to images with the specified owners. You can specify a combination of \n Amazon Web Services account IDs, self, amazon, and aws-marketplace. \n If you omit this parameter, the results include all images for which you have launch permissions, \n regardless of ownership.
Scopes the results to images with the specified owners. You can specify a combination of\n Amazon Web Services account IDs, self, amazon, and\n aws-marketplace. If you omit this parameter, the results include all images for\n which you have launch permissions, regardless of ownership.
Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User\n Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nDescribes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User\n Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
", + "smithy.api#documentation": "Describes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Describes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nAs a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
\nAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
\nFor more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nAs a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
\nAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
\nFor more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\nFor more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\nFor more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nThe token to include in another request to get the next page of items. This value is null when there\n are no more items to return.
The token to include in another request to get the next page of items. This value is\n an empty string (\"\") or null when there are no more items to return.
Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.
\nFor each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.
\nFor each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -38224,7 +38231,7 @@ "ImageIds": { "target": "com.amazonaws.ec2#ImageIdList", "traits": { - "smithy.api#documentation": "The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
", + "smithy.api#documentation": "The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a\n request.
", "smithy.api#xmlName": "ImageId" } }, @@ -42742,7 +42749,7 @@ "target": "com.amazonaws.ec2#DisableFastLaunchResult" }, "traits": { - "smithy.api#documentation": "Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tAfter you disable Windows fast launch, the AMI uses the standard launch process for each \n\t\t\tnew instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again.
\nYou can only change these settings for Windows AMIs that you own or that have been shared with you.
\nDiscontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned\n snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for\n each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable\n Windows fast launch again.
\nYou can only change these settings for Windows AMIs that you own or that have been\n shared with you.
\nForces the image settings to turn off Windows fast launch for your Windows AMI. This parameter overrides \n\t\t\tany errors that are encountered while cleaning up resources in your account.
" + "smithy.api#documentation": "Forces the image settings to turn off Windows fast launch for your Windows AMI. This\n parameter overrides any errors that are encountered while cleaning up resources in your\n account.
" } }, "DryRun": { @@ -42788,7 +42795,7 @@ "target": "com.amazonaws.ec2#FastLaunchResourceType", "traits": { "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "The pre-provisioning resource type that must be cleaned after turning off Windows fast launch \n\t\t\tfor the Windows AMI. Supported values include: snapshot.
The pre-provisioning resource type that must be cleaned after turning off Windows fast\n launch for the Windows AMI. Supported values include: snapshot.
Parameters that were used for Windows fast launch for the Windows AMI before \n\t\t\tWindows fast launch was disabled. This informs the clean-up process.
", + "smithy.api#documentation": "Parameters that were used for Windows fast launch for the Windows AMI before Windows fast\n launch was disabled. This informs the clean-up process.
", "smithy.api#xmlName": "snapshotConfiguration" } }, @@ -42804,7 +42811,7 @@ "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "The launch template that was used to launch Windows instances from pre-provisioned snapshots.
", + "smithy.api#documentation": "The launch template that was used to launch Windows instances from pre-provisioned\n snapshots.
", "smithy.api#xmlName": "launchTemplate" } }, @@ -42812,7 +42819,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MaxParallelLaunches", - "smithy.api#documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to \n\t\t\tcreate pre-provisioned snapshots for Windows fast launch.
", + "smithy.api#documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch.
", "smithy.api#xmlName": "maxParallelLaunches" } }, @@ -43137,7 +43144,7 @@ "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessResult" }, "traits": { - "smithy.api#documentation": "Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.
\nThe API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.
For more information, see Block public access to your AMIs in\n the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.
\nThe API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.
For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest": { @@ -46101,7 +46108,7 @@ "target": "com.amazonaws.ec2#EnableFastLaunchResult" }, "traits": { - "smithy.api#documentation": "When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.
\nYou can only change these settings for Windows AMIs that you own or that have been shared with you.
\nWhen you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using\n snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2\n launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a\n set of reserved snapshots that are used for subsequent launches. The reserved snapshots are\n automatically replenished as they are used, depending on your settings for launch\n frequency.
\nYou can only change these settings for Windows AMIs that you own or that have been\n shared with you.
\nThe type of resource to use for pre-provisioning the AMI for Windows fast launch. \n\t\t\tSupported values include: snapshot, which is the default value.
The type of resource to use for pre-provisioning the AMI for Windows fast launch.\n Supported values include: snapshot, which is the default value.
Configuration settings for creating and managing the snapshots that are used for \n\t\t\tpre-provisioning the AMI for Windows fast launch. The associated ResourceType \n\t\t\tmust be snapshot.
Configuration settings for creating and managing the snapshots that are used for\n pre-provisioning the AMI for Windows fast launch. The associated ResourceType\n must be snapshot.
The launch template to use when launching Windows instances from pre-provisioned \n\t\t\tsnapshots. Launch template parameters can include either the name or ID of the launch \n\t\t\ttemplate, but not both.
" + "smithy.api#documentation": "The launch template to use when launching Windows instances from pre-provisioned\n snapshots. Launch template parameters can include either the name or ID of the launch\n template, but not both.
" } }, "MaxParallelLaunches": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create \n\t\t\tpre-provisioned snapshots for Windows fast launch. Value must be \n\t\t\t6 or greater.
The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch. Value must be 6 or\n greater.
The type of resource that was defined for pre-provisioning the AMI for Windows fast launch.
", + "smithy.api#documentation": "The type of resource that was defined for pre-provisioning the AMI for Windows fast\n launch.
", "smithy.api#xmlName": "resourceType" } }, @@ -46173,7 +46180,7 @@ "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", "traits": { "aws.protocols#ec2QueryName": "SnapshotConfiguration", - "smithy.api#documentation": "Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster \n\t\t\tlaunches from the Windows AMI. This property is returned when the associated \n\t\t\tresourceType is snapshot.
Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster\n launches from the Windows AMI. This property is returned when the associated\n resourceType is snapshot.
The launch template that is used when launching Windows instances from pre-provisioned snapshots.
", + "smithy.api#documentation": "The launch template that is used when launching Windows instances from pre-provisioned\n snapshots.
", "smithy.api#xmlName": "launchTemplate" } }, @@ -46189,7 +46196,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MaxParallelLaunches", - "smithy.api#documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to \n\t\t\tcreate pre-provisioned snapshots for Windows fast launch.
", + "smithy.api#documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch.
", "smithy.api#xmlName": "maxParallelLaunches" } }, @@ -46564,7 +46571,7 @@ "target": "com.amazonaws.ec2#EnableImageDeprecationResult" }, "traits": { - "smithy.api#documentation": "Enables deprecation of the specified AMI at the specified date and time.
\nFor more information, see Deprecate an AMI in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Enables deprecation of the specified AMI at the specified date and time.
\nFor more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#EnableImageDeprecationRequest": { @@ -46582,7 +46589,7 @@ "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.
\nYou can’t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now, except for public AMIs, where the upper limit is 2 years from the creation date.
The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
\nYou can’t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now, except for public AMIs, where the upper limit is 2 years from the creation\n date.
Specify the ID of the launch template that the AMI should use for Windows fast launch.
" + "smithy.api#documentation": "Specify the ID of the launch template that the AMI should use for Windows fast\n launch.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Specify the name of the launch template that the AMI should use for Windows fast launch.
" + "smithy.api#documentation": "Specify the name of the launch template that the AMI should use for Windows fast\n launch.
" } }, "Version": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specify the version of the launch template that the AMI should use for Windows fast launch.
", + "smithy.api#documentation": "Specify the version of the launch template that the AMI should use for Windows fast\n launch.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to create a launch template for a Windows fast launch enabled AMI.
\nNote - You can specify either the LaunchTemplateName or the \n\t\t\t\tLaunchTemplateId, but not both.
Request to create a launch template for a Windows fast launch enabled AMI.
\nNote - You can specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The number of pre-provisioned snapshots to keep on hand for a Windows fast launch \n\t\t\tenabled AMI.
" + "smithy.api#documentation": "The number of pre-provisioned snapshots to keep on hand for a Windows fast launch enabled\n AMI.
" } } }, "traits": { - "smithy.api#documentation": "Configuration settings for creating and managing pre-provisioned snapshots for a Windows fast launch \n\t\t\tenabled AMI.
" + "smithy.api#documentation": "Configuration settings for creating and managing pre-provisioned snapshots for a Windows\n fast launch enabled AMI.
" } }, "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse": { @@ -48636,13 +48643,13 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "TargetResourceCount", - "smithy.api#documentation": "The number of pre-provisioned snapshots requested to keep on hand for a Windows fast launch \n\t\t\tenabled AMI.
", + "smithy.api#documentation": "The number of pre-provisioned snapshots requested to keep on hand for a Windows fast\n launch enabled AMI.
", "smithy.api#xmlName": "targetResourceCount" } } }, "traits": { - "smithy.api#documentation": "Configuration settings for creating and managing pre-provisioned snapshots for a Windows fast launch \n\t\t\tenabled Windows AMI.
" + "smithy.api#documentation": "Configuration settings for creating and managing pre-provisioned snapshots for a Windows\n fast launch enabled Windows AMI.
" } }, "com.amazonaws.ec2#FastLaunchStateCode": { @@ -49485,7 +49492,7 @@ "target": "com.amazonaws.ec2#Double", "traits": { "aws.protocols#ec2QueryName": "WeightedCapacity", - "smithy.api#documentation": "The number of units provided by the specified instance type.
", + "smithy.api#documentation": "The number of units provided by the specified instance type.
\nWhen specifying weights, the price used in the lowest-price and\n price-capacity-optimized allocation strategies is per\n unit hour (where the instance price is divided by the specified\n weight). However, if all the specified weights are above the requested\n TargetCapacity, resulting in only 1 instance being launched, the price\n used is per instance hour.
The number of units provided by the specified instance type.
" + "smithy.api#documentation": "The number of units provided by the specified instance type.
\nWhen specifying weights, the price used in the lowest-price and\n price-capacity-optimized allocation strategies is per\n unit hour (where the instance price is divided by the specified\n weight). However, if all the specified weights are above the requested\n TargetCapacity, resulting in only 1 instance being launched, the price\n used is per instance hour.
Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.
Indicates whether the image has public launch permissions. The value is true\n if this image has public launch permissions or false if it has only implicit and\n explicit launch permissions.
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.\n usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price\n \tList API. You can view these fields on the Instances or \n \tAMIs pages in the Amazon EC2 console, or in the responses that are \n \treturned by the DescribeImages \n \tcommand in the Amazon EC2 API, or the describe-images \n \tcommand in the CLI.
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.\n usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price\n List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console,\n or in the responses that are returned by the DescribeImages command in\n the Amazon EC2 API, or the describe-images command in the\n CLI.
The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
The current state of the AMI. If the state is available, the image is\n successfully registered and can be used to launch an instance.
The Amazon Web Services account alias (for example, amazon, self) or\n the Amazon Web Services account ID of the AMI owner.
The Amazon Web Services account alias (for example, amazon, self)\n or the Amazon Web Services account ID of the AMI owner.
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
", + "smithy.api#documentation": "The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance\n store volume.
", "smithy.api#xmlName": "rootDeviceType" } }, @@ -55561,7 +55568,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", + "smithy.api#documentation": "Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is\n enabled.
", "smithy.api#xmlName": "sriovNetSupport" } }, @@ -55601,7 +55608,7 @@ "target": "com.amazonaws.ec2#TpmSupportValues", "traits": { "aws.protocols#ec2QueryName": "TpmSupport", - "smithy.api#documentation": "If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon EC2 User Guide.
If the image is configured for NitroTPM support, the value is v2.0. For more\n information, see NitroTPM in the Amazon EC2 User Guide.
The date and time to deprecate the AMI, in UTC, in the following format: \n YYYY-MM-DDTHH:MM:SSZ.\n If you specified a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.
", + "smithy.api#documentation": "The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
", "smithy.api#xmlName": "deprecationTime" } }, @@ -55617,7 +55624,7 @@ "target": "com.amazonaws.ec2#ImdsSupportValues", "traits": { "aws.protocols#ec2QueryName": "ImdsSupport", - "smithy.api#documentation": "If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure the AMI in the Amazon EC2 User Guide.
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", + "smithy.api#documentation": "Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is\n enabled.
", "smithy.api#xmlName": "sriovNetSupport" } }, @@ -55721,7 +55728,7 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "UefiData", - "smithy.api#documentation": "Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "uefiData" } }, @@ -55737,7 +55744,7 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "ImdsSupport", - "smithy.api#documentation": "If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure the AMI in the Amazon EC2 User Guide.
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\n an identified Spot price. The identified Spot price is the Spot price of the lowest priced\n current generation C, M, or R instance type with your specified attributes. If no current\n generation C, M, or R instance type matches your attributes, then the identified Spot price\n is from the lowest priced current generation instance types, and failing that, from the\n lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose Spot\n price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nTo indicate no price protection threshold, specify a high value, such as\n 999999.
If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the per-vCPU\n or per-memory price instead of the per-instance price.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
\nOnly one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, then SpotMaxPricePercentageOverLowestPrice is used\n and the value for that parameter defaults to 100.
Default: 100\n
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\n an identified Spot price. The identified Spot price is the Spot price of the lowest priced\n current generation C, M, or R instance type with your specified attributes. If no current\n generation C, M, or R instance type matches your attributes, then the identified Spot price\n is from the lowest priced current generation instance types, and failing that, from the\n lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose Spot\n price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nIf you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the per-vCPU\n or per-memory price instead of the per-instance price.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
\nOnly one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.
Default: 100\n
[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nTo indicate no price protection threshold, specify a high value, such as\n 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, then SpotMaxPricePercentageOverLowestPrice is used\n and the value for that parameter defaults to 100.
[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nIf you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\n an identified Spot price. The identified Spot price is the Spot price of the lowest priced\n current generation C, M, or R instance type with your specified attributes. If no current\n generation C, M, or R instance type matches your attributes, then the identified Spot price\n is from the lowest priced current generation instance types, and failing that, from the\n lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose Spot\n price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nTo indicate no price protection threshold, specify a high value, such as 999999.
If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
\nOnly one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, then SpotMaxPricePercentageOverLowestPrice is used\n and the value for that parameter defaults to 100.
Default: 100\n
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\n an identified Spot price. The identified Spot price is the Spot price of the lowest priced\n current generation C, M, or R instance type with your specified attributes. If no current\n generation C, M, or R instance type matches your attributes, then the identified Spot price\n is from the lowest priced current generation instance types, and failing that, from the\n lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose Spot\n price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nIf you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
\nOnly one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.
Default: 100\n
[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nTo indicate no price protection threshold, specify a high value, such as\n 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, then SpotMaxPricePercentageOverLowestPrice is used\n and the value for that parameter defaults to 100.
[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.
\nIf you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.
The network nodes. The nodes are hashed based on your account. Instances from\n different accounts running under the same droplet will return a different hashed list of\n strings.
", + "smithy.api#documentation": "The network nodes. The nodes are hashed based on your account. Instances from\n different accounts running under the same server will return a different hashed list of\n strings.
", "smithy.api#xmlName": "networkNodeSet" } }, @@ -69264,13 +69271,13 @@ "Add": { "target": "com.amazonaws.ec2#LaunchPermissionList", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.
" + "smithy.api#documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of\n launch permissions for the AMI.
" } }, "Remove": { "target": "com.amazonaws.ec2#LaunchPermissionList", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.
" + "smithy.api#documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of\n launch permissions for the AMI.
" } } }, @@ -70845,7 +70852,7 @@ "target": "com.amazonaws.ec2#Double", "traits": { "aws.protocols#ec2QueryName": "WeightedCapacity", - "smithy.api#documentation": "The number of units provided by the specified instance type.
", + "smithy.api#documentation": "The number of units provided by the specified instance type.
\nWhen specifying weights, the price used in the lowest-price and\n price-capacity-optimized allocation strategies is per\n unit hour (where the instance price is divided by the specified\n weight). However, if all the specified weights are above the requested\n TargetCapacity, resulting in only 1 instance being launched, the price\n used is per instance hour.
Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Lists one or more AMIs that are currently in the Recycle Bin. For more information, see\n Recycle\n Bin in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -71455,7 +71462,7 @@ "ImageIds": { "target": "com.amazonaws.ec2#ImageIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that \n are in the Recycle Bin. You can specify up to 20 IDs in a single request.
", + "smithy.api#documentation": "The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the\n Recycle Bin. You can specify up to 20 IDs in a single request.
", "smithy.api#xmlName": "ImageId" } }, @@ -74077,7 +74084,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
\nTo specify the attribute, you can use the Attribute parameter, or one of the following parameters: \n Description, ImdsSupport, or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
\nTo enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.
", + "smithy.api#documentation": "Modifies the specified attribute of the specified AMI. You can specify only one attribute\n at a time.
\nTo specify the attribute, you can use the Attribute parameter, or one of the\n following parameters: Description, ImdsSupport, or\n LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
\nTo enable the SriovNetSupport enhanced networking attribute of an image, enable\n SriovNetSupport on an instance and create an AMI from the instance.
", "smithy.api#examples": [ { "title": "To make an AMI public", @@ -74118,7 +74125,7 @@ "Attribute": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The name of the attribute to modify.
\nValid values: description | imdsSupport | launchPermission\n
The name of the attribute to modify.
\nValid values: description | imdsSupport |\n launchPermission\n
The operation type. \n This parameter can be used only when the Attribute parameter is launchPermission.
The operation type. This parameter can be used only when the Attribute\n parameter is launchPermission.
The user groups. \n This parameter can be used only when the Attribute parameter is launchPermission.
The user groups. This parameter can be used only when the Attribute parameter\n is launchPermission.
The Amazon Web Services account IDs. \n This parameter can be used only when the Attribute parameter is launchPermission.
The Amazon Web Services account IDs. This parameter can be used only when the\n Attribute parameter is launchPermission.
The value of the attribute being modified. \n This parameter can be used only when the Attribute parameter is description or imdsSupport.
The value of the attribute being modified. This parameter can be used only when the\n Attribute parameter is description or\n imdsSupport.
The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
The Amazon Resource Name (ARN) of an organization. This parameter can be used only when\n the Attribute parameter is launchPermission.
The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used\n only when the Attribute parameter is launchPermission.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, \n you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the\n value to v2.0, you can't undo it. The only way to “reset” your AMI is to create\n a new AMI from the underlying snapshot.
Modifies the placement attributes for a specified instance. You can do the\n following:
\nModify the affinity between an instance and a Dedicated\n Host. When affinity is set to host and the instance is\n not associated with a specific Dedicated Host, the next time the instance is\n launched, it is automatically associated with the host on which it lands. If the\n instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
\nChange the instance tenancy of an instance.
\nMove an instance to or from a placement\n group.
\nAt least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.
\nTo modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.
Modifies the placement attributes for a specified instance. You can do the\n following:
\nModify the affinity between an instance and a Dedicated\n Host. When affinity is set to host and the instance is\n not associated with a specific Dedicated Host, the next time the instance is\n started, it is automatically associated with the host on which it lands. If the\n instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
\nChange the instance tenancy of an instance.
\nMove an instance to or from a placement\n group.
\nAt least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.
\nTo modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.
The affinity setting for the instance.
", + "smithy.api#documentation": "The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "affinity" } }, @@ -84887,7 +84894,7 @@ "target": "com.amazonaws.ec2#RegisterImageResult" }, "traits": { - "smithy.api#documentation": "Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.
\nIf needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. \n If you make changes to an image, deregister the previous image and register the new image.
\n\n Register a snapshot of a root device volume\n
\nYou can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.
\n\n Amazon Web Services Marketplace product codes\n
\nIf any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.
\nWindows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:
\nLaunch an instance from an existing AMI with that billing product code.
\nCustomize the instance.
\nCreate an AMI from the instance using CreateImage.
\nIf you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI\n is the final step in the creation process. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.
\nIf needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n backed by an instance store volume invalidates its registration. If you make changes to an\n image, deregister the previous image and register the new image.
\n\n Register a snapshot of a root device volume\n
\nYou can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot\n of a root device volume. You specify the snapshot using a block device mapping. You can't set\n the encryption state of the volume using the block device mapping. If the snapshot is\n encrypted, or encryption by default is enabled, the root volume of an instance launched from\n the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed\n AMIs in the Amazon Elastic Compute Cloud User Guide.
\n\n Amazon Web Services Marketplace product codes\n
\nIf any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
\nWindows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:
\nLaunch an instance from an existing AMI with that billing product code.
\nCustomize the instance.
\nCreate an AMI from the instance using CreateImage.
\nIf you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#RegisterImageRequest": { @@ -84896,21 +84903,21 @@ "ImageLocation": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the \n \t\taws-exec-read canned access control list (ACL) to ensure that it can be accessed \n \t\tby Amazon EC2. For more information, see Canned ACLs in the \n \t\tAmazon S3 Service Developer Guide.
The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the\n aws-exec-read canned access control list (ACL) to ensure that it can be\n accessed by Amazon EC2. For more information, see Canned ACLs in the\n Amazon S3 Service Developer Guide.
The architecture of the AMI.
\nDefault: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.
The architecture of the AMI.
\nDefault: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the\n architecture specified in the manifest file.
The block device mapping entries.
\nIf you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
\nIf you create an AMI on an Outpost, then all backing snapshots must be on the same\n Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can\n be used to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The block device mapping entries.
\nIf you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the\n encryption state of the volume.
\nIf you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost\n or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used\n to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "BlockDeviceMapping" } }, @@ -84934,7 +84941,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", + "smithy.api#documentation": "Set to true to enable enhanced networking with ENA for the AMI and any\n instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make\n instances launched from the AMI unreachable.
", "smithy.api#xmlName": "enaSupport" } }, @@ -84951,7 +84958,7 @@ "traits": { "aws.protocols#ec2QueryName": "Name", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A name for your AMI.
\nConstraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", + "smithy.api#documentation": "A name for your AMI.
\nConstraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces\n ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or\n underscores(_)
", "smithy.api#required": {}, "smithy.api#xmlName": "name" } @@ -84959,7 +84966,7 @@ "BillingProducts": { "target": "com.amazonaws.ec2#BillingProductList", "traits": { - "smithy.api#documentation": "The billing product codes. Your account must be authorized to specify billing product codes.
\nIf your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based\n products in the Amazon Web Services Marketplace Seller Guide.
", + "smithy.api#documentation": "The billing product codes. Your account must be authorized to specify billing product\n codes.
\nIf your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based products in the\n Amazon Web Services Marketplace Seller Guide.
", "smithy.api#xmlName": "BillingProduct" } }, @@ -84983,7 +84990,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", + "smithy.api#documentation": "Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make\n instances launched from the AMI unreachable.
", "smithy.api#xmlName": "sriovNetSupport" } }, @@ -84998,7 +85005,7 @@ "BootMode": { "target": "com.amazonaws.ec2#BootModeValues", "traits": { - "smithy.api#documentation": "The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
\nFor more information, see Boot modes in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "The boot mode of the AMI. A value of uefi-preferred indicates that the AMI\n supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified\n boot mode.
\nFor more information, see Boot modes in the\n Amazon EC2 User Guide.
" } }, "TpmSupport": { @@ -85016,7 +85023,14 @@ "ImdsSupport": { "target": "com.amazonaws.ec2#ImdsSupportValues", "traits": { - "smithy.api#documentation": "Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support\n IMDSv2.
The tags to apply to the AMI.
\nTo tag the AMI, the value for ResourceType must be image. If you\n specify another value for ResourceType, the request fails.
To tag an AMI after it has been registered, see CreateTags.
", + "smithy.api#xmlName": "TagSpecification" } } }, @@ -88614,7 +88628,7 @@ "target": "com.amazonaws.ec2#ResetImageAttributeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The attribute to reset (currently you can only reset the launch permission attribute).
", + "smithy.api#documentation": "The attribute to reset (currently you can only reset the launch permission\n attribute).
", "smithy.api#required": {} } }, @@ -89767,7 +89781,7 @@ "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinResult" }, "traits": { - "smithy.api#documentation": "Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest": { @@ -91432,14 +91446,14 @@ "AWSAccessKeyId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The access key ID of the owner of the bucket. Before you specify a value for your access\n key ID, review and follow the guidance in Best\n Practices for Amazon Web Services accounts in the Account ManagementReference\n Guide.
" + "smithy.api#documentation": "The access key ID of the owner of the bucket. Before you specify a value for your access\n key ID, review and follow the guidance in Best Practices for Amazon Web Services\n accounts in the Account ManagementReference Guide.
" } }, "Bucket": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Bucket", - "smithy.api#documentation": "The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
", + "smithy.api#documentation": "The bucket in which to store the AMI. You can specify a bucket that you already own or a\n new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone\n else, Amazon EC2 returns an error.
", "smithy.api#xmlName": "bucket" } }, @@ -91455,7 +91469,7 @@ "target": "com.amazonaws.ec2#Blob", "traits": { "aws.protocols#ec2QueryName": "UploadPolicy", - "smithy.api#documentation": "An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
", + "smithy.api#documentation": "An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your\n behalf.
", "smithy.api#xmlName": "uploadPolicy" } }, @@ -91469,7 +91483,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.
" + "smithy.api#documentation": "Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed\n AMI.
" } }, "com.amazonaws.ec2#S3StorageUploadPolicySignature": { @@ -92104,7 +92118,7 @@ "AssociatePublicIpAddress": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to instances launched in a VPC. The\n public IPv4 address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.
Starting on February 1, 2024, Amazon Web Services will charge for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
" + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to instances launched in a VPC. The\n public IPv4 address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
" } }, "DeleteOnTermination": { diff --git a/codegen/sdk-codegen/aws-models/eks.2017-11-01.json b/codegen/sdk-codegen/aws-models/eks.2017-11-01.json index 85b8a563ad2..19dd684998a 100644 --- a/codegen/sdk-codegen/aws-models/eks.2017-11-01.json +++ b/codegen/sdk-codegen/aws-models/eks.2017-11-01.json @@ -103,6 +103,18 @@ "traits": { "smithy.api#enumValue": "WINDOWS_FULL_2022_x86_64" } + }, + "AL2023_x86_64_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2023_x86_64_STANDARD" + } + }, + "AL2023_ARM_64_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2023_ARM_64_STANDARD" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json b/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json index 67131313aa2..b11c58914b7 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json +++ b/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json @@ -4135,7 +4135,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication\n group.
\nThis API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.
\nA Redis (cluster mode disabled) replication group is a collection of clusters, where\n one of the clusters is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.
\nA Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.
\nThe node or shard limit can be increased to a maximum of 500 per cluster if the Redis\n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.
\nTo request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.
\nWhen a Redis (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can avail\n yourself of ElastiCache for Redis' scaling. For more information, see Scaling\n ElastiCache for Redis Clusters in the ElastiCache User\n Guide.
\nThis operation is valid for Redis only.
\nCreates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication\n group.
\nThis API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.
\nA Redis (cluster mode disabled) replication group is a collection of nodes, where\n one of the nodes is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.
\nA Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.
\nThe node or shard limit can be increased to a maximum of 500 per cluster if the Redis\n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.
\nTo request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.
\nWhen a Redis (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can avail\n yourself of ElastiCache for Redis' scaling. For more information, see Scaling\n ElastiCache for Redis Clusters in the ElastiCache User\n Guide.
\nThis operation is valid for Redis only.
\nSpecifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period. Valid values for ddd\n are:
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Represents the information required for client programs to connect to a cache\n node.
" + "smithy.api#documentation": "Represents the information required for client programs to connect to a cache\n node. This value is read-only.
" } }, "com.amazonaws.elasticache#EngineDefaults": { @@ -12451,7 +12451,7 @@ "ReaderEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "The endpoint of the replica nodes in this node group (shard).
" + "smithy.api#documentation": "The endpoint of the replica nodes in this node group (shard). This value is read-only.
" } }, "Slots": { @@ -14641,7 +14641,7 @@ "SubnetIds": { "target": "com.amazonaws.elasticache#SubnetIdsList", "traits": { - "smithy.api#documentation": "If no subnet IDs are given and your VPC is in SFO, then ElastiCache will select 2 default subnets across AZs in your VPC. \n For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
" + "smithy.api#documentation": "If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. \n For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
" } }, "SnapshotRetentionLimit": { diff --git a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json index 03c645b432a..42c5e7570be 100644 --- a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json +++ b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json @@ -2494,7 +2494,7 @@ } }, "traits": { - "smithy.api#documentation": "Used to specify the configuration options for a volume's storage aggregate or aggregates.
" + "smithy.api#documentation": "Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
" } }, "com.amazonaws.fsx#CreateBackup": { @@ -3284,7 +3284,7 @@ "RouteTableIds": { "target": "com.amazonaws.fsx#RouteTableIds", "traits": { - "smithy.api#documentation": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\n for routing traffic to the correct file server. You should specify all virtual private cloud\n (VPC) route tables associated with the subnets in which your clients are located. By default,\n Amazon FSx selects your VPC's default route table.
" + "smithy.api#documentation": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\n for routing traffic to the correct file server. You should specify all virtual private cloud\n (VPC) route tables associated with the subnets in which your clients are located. By default,\n Amazon FSx selects your VPC's default route table.
\nAmazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. \n These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. \n When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the \n Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.
Specifies how many high-availability (HA) pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 6.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. \n FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nYou can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.
This field and ThroughputCapacity are the same for scale-up file systems powered by one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
\n\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType and the Lustre DeploymentType, as\n follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maxium is calculated as 524,288 * HAPairs..
\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
\n\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
\nFor HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
\nSets the storage capacity of the file system that you're creating, in gibibytes (GiB).
\n\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType and the Lustre DeploymentType, as\n follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.
\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
\n\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
\nFor HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
\nA list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.
" + "smithy.api#documentation": "A list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.
\nYou must specify a security group if you are creating a Multi-AZ \n FSx for ONTAP file system in a VPC subnet that has been shared with you.
\nSpecifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. For more information, see \n Volume security style \n in the Amazon FSx for NetApp ONTAP User Guide.\n Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n
\n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED if the file system is managed by both UNIX\n and Windows administrators and users consist of both NFS and SMB clients.
Specifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. For more information, see \n Volume security style \n in the Amazon FSx for NetApp ONTAP User Guide.\n Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n
\n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED This is an advanced setting. For more information, see the topic \n What the security styles and their effects are \n in the NetApp Documentation Center.
For more information, see Volume security style in the \n FSx for ONTAP User Guide.
" } }, "SizeInMegabytes": { @@ -3585,13 +3585,13 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use SizeInBytes instead" }, - "smithy.api#documentation": "Specifies the size of the volume, in megabytes (MB), that you are creating.
" + "smithy.api#documentation": "Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
Set to true to enable deduplication, compression, and compaction storage\n efficiency features on the volume, or set to false to disable them.\n This parameter is required.
" + "smithy.api#documentation": "Set to true to enable deduplication, compression, and compaction storage\n efficiency features on the volume, or set to false to disable them.
\n\n StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType set to RW).
Specifies the type of volume you are creating. Valid values are the following:
\n\n RW specifies a read/write volume. RW is the default.
\n DP specifies a data-protection volume. A DP volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Specifies the type of volume you are creating. Valid values are the following:
\n\n RW specifies a read/write volume. RW is the default.
\n DP specifies a data-protection volume. A DP volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "SnapshotPolicy": { "target": "com.amazonaws.fsx#SnapshotPolicy", "traits": { - "smithy.api#documentation": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
\n\n default: This is the default policy. A maximum of six hourly snapshots taken five minutes past \n the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after\n midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
\n default-1weekly: This policy is the same as the default policy except \n that it only retains one snapshot from the weekly schedule.
\n none: This policy does not take any snapshots. This policy can be assigned to volumes to \n prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
\nFor more information, see Snapshot policies \n in the Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
\n\n default: This is the default policy. A maximum of six hourly snapshots taken five minutes past \n the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after\n midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
\n default-1weekly: This policy is the same as the default policy except \n that it only retains one snapshot from the weekly schedule.
\n none: This policy does not take any snapshots. This policy can be assigned to volumes to \n prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
\nFor more information, see Snapshot policies \n in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "CopyTagsToBackups": { @@ -3632,7 +3632,7 @@ "VolumeStyle": { "target": "com.amazonaws.fsx#VolumeStyle", "traits": { - "smithy.api#documentation": "Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, \n FlexVol and FlexGroup volumes. For more information, see \n Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "AggregateConfiguration": { @@ -3644,7 +3644,7 @@ "SizeInBytes": { "target": "com.amazonaws.fsx#VolumeCapacityBytes", "traits": { - "smithy.api#documentation": "The configured size of the volume, in bytes.
" + "smithy.api#documentation": "Specifies the configured size of the volume, in bytes.
" } } }, @@ -3737,7 +3737,7 @@ "UserAndGroupQuotas": { "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", "traits": { - "smithy.api#documentation": "An object specifying how much storage users or groups can use on the volume.
" + "smithy.api#documentation": "Configures how much storage users and groups can use on the volume.
" } } }, @@ -3906,7 +3906,7 @@ "ActiveDirectoryConfiguration": { "target": "com.amazonaws.fsx#CreateSvmActiveDirectoryConfiguration", "traits": { - "smithy.api#documentation": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. \n Joining an Active Directory provides user authentication and access control for SMB clients, \n including Microsoft Windows and macOS client accessing the file system.
" + "smithy.api#documentation": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. \n Joining an Active Directory provides user authentication and access control for SMB clients, \n including Microsoft Windows and macOS clients accessing the file system.
" } }, "ClientRequestToken": { @@ -3942,7 +3942,7 @@ "RootVolumeSecurityStyle": { "target": "com.amazonaws.fsx#StorageVirtualMachineRootVolumeSecurityStyle", "traits": { - "smithy.api#documentation": "The security style of the root volume of the SVM. Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.
\n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED if the file system is managed by both UNIX\n and Windows administrators and users consist of both NFS and SMB clients.
The security style of the root volume of the SVM. Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.
\n NTFS if the file system is managed by a Microsoft Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Microsoft Windows user as the service account.
\n MIXED This is an advanced setting. For more information, see \n Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
The configuration that Amazon FSx uses to join the ONTAP storage virtual machine\n (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
" + "smithy.api#documentation": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine\n (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.
" } }, "com.amazonaws.fsx#CreateVolume": { @@ -6105,7 +6105,7 @@ } ], "traits": { - "smithy.api#documentation": "Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual\n private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User\n Guide.
" + "smithy.api#documentation": "Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual\n private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.
" } }, "com.amazonaws.fsx#DescribeSharedVpcConfigurationRequest": { @@ -6181,7 +6181,7 @@ "IncludeShared": { "target": "com.amazonaws.fsx#IncludeShared", "traits": { - "smithy.api#documentation": "Set to false (default) if you want to only see the snapshots in your\n Amazon Web Services account. Set to true if you want to see the\n snapshots in your account and the ones shared with you from another account.
Set to false (default) if you want to only see the snapshots owned by your\n Amazon Web Services account. Set to true if you want to see the\n snapshots in your account and the ones shared with you from another account.
Specifies whether the file system is \n using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, , or \n if it using a USER_PROVISIONED value.
Specifies whether the file system is \n using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or \n if it using a USER_PROVISIONED value.
The tags to associate with the file system. For more information, see Tagging your\n Amazon EC2 resources in the Amazon EC2 User\n Guide.
" + "smithy.api#documentation": "The tags to associate with the file system. For more information, see Tagging your\n Amazon FSx resources in the Amazon FSx for Lustre User\n Guide.
" } }, "WindowsConfiguration": { @@ -7511,7 +7511,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 6 + "max": 12 } } }, @@ -8412,13 +8412,13 @@ "HAPairs": { "target": "com.amazonaws.fsx#HAPairs", "traits": { - "smithy.api#documentation": "Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 6.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
A value that specifies whether the quota applies to a user or group.
", + "smithy.api#documentation": "Specifies whether the quota applies to a user or group.
", "smithy.api#required": {} } }, @@ -8897,7 +8897,7 @@ "target": "com.amazonaws.fsx#IntegerNoMax", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the user or group.
", + "smithy.api#documentation": "The ID of the user or group that the quota applies to.
", "smithy.api#required": {} } }, @@ -8905,13 +8905,13 @@ "target": "com.amazonaws.fsx#IntegerNoMax", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The amount of storage that the user or group can use in gibibytes (GiB).
", + "smithy.api#documentation": "The user or group's storage quota, in gibibytes (GiB).
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The configuration for how much storage a user or group can use on the volume.
" + "smithy.api#documentation": "Used to configure quotas that define how much storage a user or group can use on an \n FSx for OpenZFS volume. For more information, see \n Volume properties\n in the FSx for OpenZFS User Guide.\n
" } }, "com.amazonaws.fsx#OpenZFSVolumeConfiguration": { @@ -11313,7 +11313,7 @@ "ThroughputCapacityPerHAPair": { "target": "com.amazonaws.fsx#ThroughputCapacityPerHAPair", "traits": { - "smithy.api#documentation": "Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 6).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
The type of license to associate with the workspace.
", + "smithy.api#documentation": "The type of license to associate with the workspace.
\nAmazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
\nA token from Grafana Labs that ties your Amazon Web Services account with a Grafana \n Labs account. For more information, see Register with Grafana Labs.
", + "smithy.api#httpHeader": "Grafana-Token" + } } } }, @@ -1402,7 +1409,7 @@ "authenticationProviders": { "target": "com.amazonaws.grafana#AuthenticationProviders", "traits": { - "smithy.api#documentation": "Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to\n authenticate users for using the Grafana console within a workspace. For more\n information, see User authentication in\n Amazon Managed Grafana.
", + "smithy.api#documentation": "Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to\n authenticate users for using the Grafana console within a workspace. For more\n information, see User authentication in\n Amazon Managed Grafana.
", "smithy.api#required": {} } }, @@ -1433,7 +1440,7 @@ "grafanaVersion": { "target": "com.amazonaws.grafana#GrafanaVersion", "traits": { - "smithy.api#documentation": "Specifies the version of Grafana to support in the new workspace.
\nTo get a list of supported version, use the ListVersions\n operation.
Specifies the version of Grafana to support in the new workspace. If not specified, \n defaults to the latest version (for example, 9.4).
\nTo get a list of supported versions, use the ListVersions\n operation.
Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to\n authenticate users for using the Grafana console within a workspace. For more\n information, see User authentication in\n Amazon Managed Grafana.
", + "smithy.api#documentation": "Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to\n authenticate users for using the Grafana console within a workspace. For more\n information, see User authentication in\n Amazon Managed Grafana.
", "smithy.api#required": {} } }, @@ -3344,7 +3360,7 @@ "grafanaVersion": { "target": "com.amazonaws.grafana#GrafanaVersion", "traits": { - "smithy.api#documentation": "Specifies the version of Grafana to support in the new workspace.
\nCan only be used to upgrade (for example, from 8.4 to 9.4), not\n downgrade (for example, from 9.4 to 8.4).
\nTo know what versions are available to upgrade to for a specific workspace, see \n the ListVersions operation.
Specifies the version of Grafana to support in the workspace. If not specified, \n keeps the current version of the workspace.
\nCan only be used to upgrade (for example, from 8.4 to 9.4), not\n downgrade (for example, from 9.4 to 8.4).
\nTo know what versions are available to upgrade to for a specific workspace, see \n the ListVersions operation.
" } } } @@ -3763,25 +3779,25 @@ "licenseType": { "target": "com.amazonaws.grafana#LicenseType", "traits": { - "smithy.api#documentation": "Specifies whether this workspace has a full Grafana Enterprise license or a free trial\n license.
" + "smithy.api#documentation": "Specifies whether this workspace has a full Grafana Enterprise license.
\nAmazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
\nSpecifies whether this workspace has already fully used its free trial for Grafana\n Enterprise.
" + "smithy.api#documentation": "Specifies whether this workspace has already fully used its free trial for Grafana\n Enterprise.
\nAmazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
\nIf this workspace has a full Grafana Enterprise license, this specifies when the\n license ends and will need to be renewed.
" + "smithy.api#documentation": "If this workspace has a full Grafana Enterprise license purchased through \n Amazon Web Services Marketplace, this specifies when the\n license ends and will need to be renewed. Purchasing the Enterprise plugins option \n through Amazon Managed Grafana does not have an expiration. It is valid until the \n license is removed.
" } }, "freeTrialExpiration": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "If this workspace is currently in the free trial period for Grafana Enterprise, this\n value specifies when that free trial ends.
" + "smithy.api#documentation": "If this workspace is currently in the free trial period for Grafana Enterprise, this\n value specifies when that free trial ends.
\nAmazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
\nThe configuration settings for network access to your workspace.
" } + }, + "grafanaToken": { + "target": "com.amazonaws.grafana#GrafanaToken", + "traits": { + "smithy.api#documentation": "The token that ties this workspace to a Grafana Labs account. For more information, \n see Register with Grafana Labs.
" + } } }, "traits": { @@ -3980,6 +4002,18 @@ "traits": { "smithy.api#documentation": "The list of tags associated with the workspace.
" } + }, + "licenseType": { + "target": "com.amazonaws.grafana#LicenseType", + "traits": { + "smithy.api#documentation": "Specifies whether this workspace has a full Grafana Enterprise license.
\nAmazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
\nThe token that ties this workspace to a Grafana Labs account. For more information, \n see Register with Grafana Labs.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json index 2a2021b95cb..ecf9db595c3 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json +++ b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json @@ -1770,7 +1770,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a single Amazon GuardDuty detector. A detector is a resource that represents the\n GuardDuty service. To start using GuardDuty, you must create a detector in each Region where\n you enable the service. You can have only one detector per account per Region. All data\n sources are enabled in a new detector by default.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#documentation": "Creates a single GuardDuty detector. A detector is a resource that represents the\n GuardDuty service. To start using GuardDuty, you must create a detector in each Region where\n you enable the service. You can have only one detector per account per Region. All data\n sources are enabled in a new detector by default.
\nWhen you don't specify any features, with an \n exception to RUNTIME_MONITORING, all the optional features are \n enabled by default.
When you specify some of the features, any feature that is not specified in the \n API call gets enabled by default, with an exception to RUNTIME_MONITORING.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector", @@ -3394,7 +3394,7 @@ "AutoEnableOrganizationMembers": { "target": "com.amazonaws.guardduty#AutoEnableMembers", "traits": { - "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in \n the organization individually.
Indicates the auto-enablement configuration of GuardDuty or any of the corresponding protection plans for the member accounts in the\n organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty or any of the corresponding protection plans enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty and any of the corresponding \n protection plans enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that GuardDuty or any of the corresponding protection plans \n will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in \n the organization individually.
When you update the auto-enable setting from ALL or NEW to \n NONE, this action doesn't disable the corresponding option for your existing accounts. This\n configuration will apply to the new accounts that join the organization. After you update the auto-enable settings,\n no new account will have the corresponding option as enabled.
Contains information about a GuardDuty feature.
" + "smithy.api#documentation": "Contains information about a GuardDuty feature.
\nSpecifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.
Contains information about a GuardDuty feature.
" + "smithy.api#documentation": "Contains information about a GuardDuty feature.
\nSpecifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.
Retrieves how many active member accounts \n in your Amazon Web Services organization have\n each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.
\nWhen you create a new Amazon Web Services organization, it might take up to 24 \n hours to generate the statistics for the entire organization.
", + "smithy.api#documentation": "Retrieves how many active member accounts have\n each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.
\nWhen you create a new organization, it might take up to 24 \n hours to generate the statistics for the entire organization.
", "smithy.api#http": { "method": "GET", "uri": "/organization/statistics", @@ -12706,7 +12706,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.
", + "smithy.api#documentation": "Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.
\nWhen the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information,\n see DescribeMalwareScans.
", "smithy.api#http": { "method": "POST", "uri": "/malware-scan/start", @@ -13459,7 +13459,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the GuardDuty detector specified by the detectorId.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#documentation": "Updates the GuardDuty detector specified by the detector ID.
\nSpecifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}", @@ -13851,7 +13851,7 @@ } ], "traits": { - "smithy.api#documentation": "Contains information on member accounts to be updated.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#documentation": "Contains information on member accounts to be updated.
\nSpecifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/detector/update", @@ -13936,7 +13936,7 @@ } ], "traits": { - "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/admin", @@ -13986,7 +13986,7 @@ "AutoEnableOrganizationMembers": { "target": "com.amazonaws.guardduty#AutoEnableMembers", "traits": { - "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
Use one of the \n following configuration values for autoEnableOrganizationMembers:
\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
Use one of the \n following configuration values for autoEnableOrganizationMembers:
\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
When you update the auto-enable setting from ALL or NEW to \n NONE, this action doesn't disable the corresponding option for your existing accounts. This\n configuration will apply to the new accounts that join the organization. After you update the auto-enable settings,\n no new account will have the corresponding option as enabled.
For an impacted container image, this identifies a list of URIs for associated \n\t\t\tcontainer images distributed to ECR repositories.
" } + }, + "startTime": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The starting timestamp from the lifecycle action that was applied to the resource.
" + } + }, + "endTime": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The ending timestamp from the lifecycle action that was applied to the resource.
" + } } }, "traits": { @@ -7507,6 +7519,12 @@ "traits": { "smithy.api#enumValue": "SUCCESS" } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } } } }, @@ -7713,7 +7731,7 @@ "tagMap": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "Contains a list of tags that Image Builder uses to skip lifecycle actions for resources that have them.
" + "smithy.api#documentation": "Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image \n\t\t\tresources that have them.
" } }, "amis": { @@ -7890,7 +7908,7 @@ "tagMap": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "A list of tags that are used as selection criteria for the resources \n\t\t\tthat the lifecycle policy applies to.
" + "smithy.api#documentation": "A list of tags that are used as selection criteria for the Image Builder image \n\t\t\tresources that the lifecycle policy applies to.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json b/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json index ba2cafd1339..90ab1cd3fbd 100644 --- a/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json +++ b/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json @@ -1761,7 +1761,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2386,7 +2386,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2535,7 +2535,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – MyFunction.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
\n Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – MyFunction.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
\n Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.
", "smithy.api#required": {} } }, @@ -2722,7 +2722,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#required": {} } }, @@ -2912,7 +2912,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3060,7 +3060,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3262,7 +3262,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3312,7 +3312,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3362,7 +3362,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3385,7 +3385,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function or version.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:1 (with version).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function or version.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:1 (with version).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3439,7 +3439,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3546,7 +3546,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4802,7 +4802,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5085,7 +5085,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5108,7 +5108,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#required": {} } } @@ -5154,7 +5154,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5325,7 +5325,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5379,7 +5379,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5402,7 +5402,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5488,7 +5488,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5836,7 +5836,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5913,7 +5913,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6012,7 +6012,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6295,7 +6295,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6557,7 +6557,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6767,7 +6767,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7406,7 +7406,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7580,7 +7580,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – MyFunction.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
\n Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – MyFunction.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
\n Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.
", "smithy.api#httpQuery": "FunctionName" } }, @@ -7666,7 +7666,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - my-function.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - my-function.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7753,7 +7753,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8207,7 +8207,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8355,7 +8355,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9092,7 +9092,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9170,7 +9170,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9193,7 +9193,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#required": {} } } @@ -9242,7 +9242,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9299,7 +9299,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9374,7 +9374,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9483,7 +9483,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9709,7 +9709,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name – my-function (name-only), my-function:v1 (with alias).
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11104,7 +11104,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name - MyFunction.
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11274,7 +11274,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – MyFunction.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
\n Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.
" + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – MyFunction.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
\n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
\n Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.
" } }, "Enabled": { @@ -11421,7 +11421,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11539,7 +11539,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11697,7 +11697,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
\n\n Name formats\n
\n\n Function name - my-function (name-only), my-function:v1 (with alias).
\n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11772,7 +11772,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#documentation": "The name or ARN of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json b/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json index 084e80fe179..4bb6405418f 100644 --- a/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json +++ b/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json @@ -2079,6 +2079,9 @@ } } }, + "com.amazonaws.lexmodelsv2#AnswerField": { + "type": "string" + }, "com.amazonaws.lexmodelsv2#AssociatedTranscript": { "type": "structure", "members": { @@ -2626,10 +2629,35 @@ "smithy.api#output": {} } }, + "com.amazonaws.lexmodelsv2#BedrockKnowledgeBaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,40}:[0-9]{12}:knowledge-base\\/[A-Za-z0-9]{10}$|^[A-Za-z0-9]{10}$" + } + }, + "com.amazonaws.lexmodelsv2#BedrockKnowledgeStoreConfiguration": { + "type": "structure", + "members": { + "bedrockKnowledgeBaseArn": { + "target": "com.amazonaws.lexmodelsv2#BedrockKnowledgeBaseArn", + "traits": { + "smithy.api#documentation": "The ARN of the knowledge base used.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the configuration of a Amazon Bedrock knowledge base.
" + } + }, "com.amazonaws.lexmodelsv2#BedrockModelArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\\/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" } }, "com.amazonaws.lexmodelsv2#BedrockModelSpecification": { @@ -4169,7 +4197,10 @@ } }, "sampleUtteranceGeneration": { - "target": "com.amazonaws.lexmodelsv2#SampleUtteranceGenerationSpecification" + "target": "com.amazonaws.lexmodelsv2#SampleUtteranceGenerationSpecification", + "traits": { + "smithy.api#documentation": "Contains specifications for the sample utterance generation feature.
" + } } }, "traits": { @@ -5883,6 +5914,12 @@ "traits": { "smithy.api#documentation": "Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when\n Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.
Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Details about the the configuration of the built-in Amazon.QnAIntent.
By default, data stored by Amazon Lex is encrypted. The\n DataPrivacy structure provides settings that determine\n how Amazon Lex handles special cases of securing the data for your bot.\n
Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.
Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent. To create a Amazon Kendra index, follow the steps at Creating an index.
Contains details about the configuration of the Amazon Bedrock knowledge base used for the AMAZON.QnAIntent. To set up a knowledge base, follow the steps at Building a knowledge base.
Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent. You must have already created the knowledge store and indexed the documents within it.
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Details about the configuration of the built-in Amazon.QnAIntent.
The current state of the conversation with the user.
" } }, + "com.amazonaws.lexmodelsv2#DomainEndpoint": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(http|https):\\/\\/+[^\\s]+[\\w]$" + } + }, "com.amazonaws.lexmodelsv2#DraftBotVersion": { "type": "string", "traits": { @@ -11291,6 +11372,28 @@ "com.amazonaws.lexmodelsv2#ErrorMessage": { "type": "string" }, + "com.amazonaws.lexmodelsv2#ExactResponseFields": { + "type": "structure", + "members": { + "questionField": { + "target": "com.amazonaws.lexmodelsv2#QuestionField", + "traits": { + "smithy.api#documentation": "The name of the field that contains the query made to the OpenSearch Service database.
", + "smithy.api#required": {} + } + }, + "answerField": { + "target": "com.amazonaws.lexmodelsv2#AnswerField", + "traits": { + "smithy.api#documentation": "The name of the field that contains the answer to the query made to the OpenSearch Service database.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields used for an exact response to the user.
" + } + }, "com.amazonaws.lexmodelsv2#ExceptionMessage": { "type": "string" }, @@ -12458,6 +12561,9 @@ "smithy.api#pattern": "^([0-9a-zA-Z_])+$" } }, + "com.amazonaws.lexmodelsv2#IncludeField": { + "type": "string" + }, "com.amazonaws.lexmodelsv2#InitialResponseSetting": { "type": "structure", "members": { @@ -17937,6 +18043,28 @@ "smithy.api#pattern": "^[0-9]+$" } }, + "com.amazonaws.lexmodelsv2#OSIncludeFields": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#IncludeField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.lexmodelsv2#OSIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?![_-])[a-z0-9][a-z0-9_\\-]{0,254}$" + } + }, "com.amazonaws.lexmodelsv2#ObfuscationSetting": { "type": "structure", "members": { @@ -17990,6 +18118,47 @@ } } }, + "com.amazonaws.lexmodelsv2#OpensearchConfiguration": { + "type": "structure", + "members": { + "domainEndpoint": { + "target": "com.amazonaws.lexmodelsv2#DomainEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint of the Amazon OpenSearch Service domain.
", + "smithy.api#required": {} + } + }, + "indexName": { + "target": "com.amazonaws.lexmodelsv2#OSIndexName", + "traits": { + "smithy.api#documentation": "The name of the Amazon OpenSearch Service index.
", + "smithy.api#required": {} + } + }, + "exactResponse": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
" + } + }, + "exactResponseFields": { + "target": "com.amazonaws.lexmodelsv2#ExactResponseFields", + "traits": { + "smithy.api#documentation": "Contains the names of the fields used for an exact response to the user.
" + } + }, + "includeFields": { + "target": "com.amazonaws.lexmodelsv2#OSIncludeFields", + "traits": { + "smithy.api#documentation": "Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent.
Specifies a list of message groups that Amazon Lex sends to a user to\n elicit a response.
" } }, + "com.amazonaws.lexmodelsv2#QnAIntentConfiguration": { + "type": "structure", + "members": { + "dataSourceConfiguration": { + "target": "com.amazonaws.lexmodelsv2#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the data source used for the AMAZON.QnAIntent.
Details about the the configuration of the built-in Amazon.QnAIntent.
The ARN of the Amazon Kendra index to use.
", + "smithy.api#required": {} + } + }, + "queryFilterStringEnabled": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to enable an Amazon Kendra filter string or not.
" + } + }, + "queryFilterString": { + "target": "com.amazonaws.lexmodelsv2#QueryFilterString", + "traits": { + "smithy.api#documentation": "Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
" + } + }, + "exactResponse": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when\n Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Details about the configuration of the built-in Amazon.QnAIntent.
The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Description": { "target": "com.amazonaws.mediapackagev2#ResourceDescription", "traits": { @@ -663,6 +672,13 @@ "IngestEndpoints": { "target": "com.amazonaws.mediapackagev2#IngestEndpointList" }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -699,8 +715,7 @@ "traits": { "smithy.api#documentation": "The total duration (in seconds) of the manifest's content.
", "smithy.api#range": { - "min": 30, - "max": 900 + "min": 30 } } }, @@ -752,8 +767,7 @@ "traits": { "smithy.api#documentation": "The total duration (in seconds) of the manifest's content.
", "smithy.api#range": { - "min": 30, - "max": 900 + "min": 30 } } }, @@ -992,6 +1006,7 @@ "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8" } ], + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -1166,6 +1181,7 @@ "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest2.m3u8" } ], + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -1352,6 +1368,13 @@ "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -1875,6 +1898,16 @@ "smithy.api#documentation": "The encryption type.
" } }, + "com.amazonaws.mediapackagev2#EntityTag": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, "com.amazonaws.mediapackagev2#FilterConfiguration": { "type": "structure", "members": { @@ -1967,6 +2000,7 @@ "Url": "https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index" } ], + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -2022,6 +2056,7 @@ "EgressDomain": "abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com", "CreatedAt": "2022-10-18T09:36:00.00Z", "ModifiedAt": "2022-10-18T09:36:00.00Z", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -2096,6 +2131,13 @@ "smithy.api#documentation": "The description for your channel group.
" } }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -2282,6 +2324,13 @@ "IngestEndpoints": { "target": "com.amazonaws.mediapackagev2#IngestEndpointList" }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -2520,6 +2569,7 @@ "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8" } ], + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -2767,6 +2817,13 @@ "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -4367,6 +4424,7 @@ "Url": "https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index" } ], + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -4427,6 +4485,7 @@ "EgressDomain": "abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com", "CreatedAt": "2022-10-18T09:36:00.00Z", "ModifiedAt": "2022-10-18T10:36:00.00Z", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -4453,6 +4512,14 @@ "smithy.api#required": {} } }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
", + "smithy.api#httpHeader": "x-amzn-update-if-match" + } + }, "Description": { "target": "com.amazonaws.mediapackagev2#ResourceDescription", "traits": { @@ -4508,6 +4575,13 @@ "smithy.api#documentation": "The description for your channel group.
" } }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -4540,6 +4614,14 @@ "smithy.api#required": {} } }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
", + "smithy.api#httpHeader": "x-amzn-update-if-match" + } + }, "Description": { "target": "com.amazonaws.mediapackagev2#ResourceDescription", "traits": { @@ -4598,6 +4680,13 @@ "IngestEndpoints": { "target": "com.amazonaws.mediapackagev2#IngestEndpointList" }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -4812,6 +4901,7 @@ "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8" } ], + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", "key2": "value2" @@ -4896,6 +4986,14 @@ "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } + }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
", + "smithy.api#httpHeader": "x-amzn-update-if-match" + } } }, "traits": { @@ -4985,6 +5083,13 @@ "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { diff --git a/codegen/sdk-codegen/aws-models/migrationhuborchestrator.2021-08-28.json b/codegen/sdk-codegen/aws-models/migrationhuborchestrator.2021-08-28.json index bb2c8c3ae73..c2586e1e8bb 100644 --- a/codegen/sdk-codegen/aws-models/migrationhuborchestrator.2021-08-28.json +++ b/codegen/sdk-codegen/aws-models/migrationhuborchestrator.2021-08-28.json @@ -76,7 +76,7 @@ "date" ] }, - "smithy.api#documentation": "This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for AWS Migration Hub Orchestrator. he topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the AWS SDKs to\n access an API that is tailored to the programming language or platform that you're\n using.
", + "smithy.api#documentation": "This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for AWS Migration Hub Orchestrator. The topic for each action shows the API\n request parameters and responses. Alternatively, you can use one of the AWS SDKs to\n access an API that is tailored to the programming language or platform that you're\n using.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -776,6 +776,33 @@ "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" } }, + "com.amazonaws.migrationhuborchestrator#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9]*$" + } + }, + "com.amazonaws.migrationhuborchestrator#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when an attempt to update or delete\n a resource would cause an inconsistent state.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409, + "smithy.api#retryable": {} + } + }, "com.amazonaws.migrationhuborchestrator#CreateMigrationWorkflowRequest": { "type": "structure", "members": { @@ -819,11 +846,10 @@ "traits": { "smithy.api#documentation": "The configuration ID of the application configured in Application Discovery Service.
", "smithy.api#length": { - "min": 1, + "min": 0, "max": 100 }, - "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$", - "smithy.api#required": {} + "smithy.api#pattern": "^[-a-zA-Z0-9_.+]*$" } }, "inputParameters": { @@ -918,6 +944,117 @@ } } }, + "com.amazonaws.migrationhuborchestrator#CreateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#CreateTemplateRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#CreateTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ConflictException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a migration workflow template.
", + "smithy.api#http": { + "method": "POST", + "uri": "/template", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#CreateTemplateRequest": { + "type": "structure", + "members": { + "templateName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow template.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[ a-zA-Z0-9]*$", + "smithy.api#required": {} + } + }, + "templateDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the migration workflow template.
", + "smithy.api#length": { + "min": 0, + "max": 250 + }, + "smithy.api#pattern": "^.*$" + } + }, + "templateSource": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateSource", + "traits": { + "smithy.api#documentation": "The source of the migration workflow template.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.migrationhuborchestrator#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Idempotency in the Smithy documentation.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.migrationhuborchestrator#TagMap", + "traits": { + "smithy.api#documentation": "The tags to add to the migration workflow template.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.migrationhuborchestrator#CreateTemplateResponse": { + "type": "structure", + "members": { + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow template.
" + } + }, + "templateArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the migration workflow template. The format for an\n Migration Hub Orchestrator template ARN is\n arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the AWS General Reference.
The tags added to the migration workflow template.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.migrationhuborchestrator#CreateWorkflow": { "type": "operation", "input": { @@ -1258,6 +1395,64 @@ } } }, + "com.amazonaws.migrationhuborchestrator#DeleteTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteTemplateRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a migration workflow template.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/template/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the request to delete a migration workflow template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.migrationhuborchestrator#DeleteTemplateResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.migrationhuborchestrator#DeleteWorkflow": { "type": "operation", "input": { @@ -1581,6 +1776,12 @@ "smithy.api#documentation": "The ID of the template.
" } }, + "templateArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": ">The Amazon Resource Name (ARN) of the migration workflow template. The format for an\n Migration Hub Orchestrator template ARN is\n arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the AWS General Reference.
List of AWS services utilized in a migration workflow.
" } }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the template was last created.
" + } + }, + "owner": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The owner of the migration workflow template.
" + } + }, "status": { "target": "com.amazonaws.migrationhuborchestrator#TemplateStatus", "traits": { "smithy.api#documentation": "The status of the template.
" } }, - "creationTime": { - "target": "smithy.api#Timestamp", + "statusMessage": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The time at which the template was last created.
" + "smithy.api#documentation": "The status message of retrieving migration workflow templates.
" + } + }, + "templateClass": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The class of the migration workflow template. The available template classes\n are:
\nA2C
\nMGN
\nSAP_MULTI
\nSQL_EC2
\nSQL_RDS
\nVMIE
\nThe tags added to the migration workflow template.
" } } } @@ -2121,7 +2346,7 @@ "stepGroupId": { "target": "com.amazonaws.migrationhuborchestrator#StepGroupId", "traits": { - "smithy.api#documentation": "desThe ID of the step group.
", + "smithy.api#documentation": "The ID of the step group.
", "smithy.api#httpQuery": "stepGroupId", "smithy.api#required": {} } @@ -2972,6 +3197,21 @@ } } }, + "com.amazonaws.migrationhuborchestrator#MaxStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhuborchestrator#MaxStringValue" + } + }, + "com.amazonaws.migrationhuborchestrator#MaxStringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.migrationhuborchestrator#MigrationWorkflow": { "type": "resource", "identifiers": { @@ -3177,9 +3417,18 @@ "target": "com.amazonaws.migrationhuborchestrator#TemplateId" } }, + "create": { + "target": "com.amazonaws.migrationhuborchestrator#CreateTemplate" + }, "read": { "target": "com.amazonaws.migrationhuborchestrator#GetTemplate" }, + "update": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateTemplate" + }, + "delete": { + "target": "com.amazonaws.migrationhuborchestrator#DeleteTemplate" + }, "list": { "target": "com.amazonaws.migrationhuborchestrator#ListTemplates" } @@ -3348,7 +3597,7 @@ "com.amazonaws.migrationhuborchestrator#ResourceArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws:migrationhub-orchestrator:[a-z0-9-]+:[0-9]+:workflow/[.]*$" + "smithy.api#pattern": "^arn:aws:migrationhub-orchestrator:[a-z0-9-]+:[0-9]+:(template|workflow)/[.]*$" } }, "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException": { @@ -3818,6 +4067,10 @@ "value": "AWAITING_DEPENDENCIES", "name": "AWAITING_DEPENDENCIES" }, + { + "value": "SKIPPED", + "name": "SKIPPED" + }, { "value": "READY", "name": "READY" @@ -3938,7 +4191,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 500 } } }, @@ -4149,6 +4402,20 @@ "smithy.api#pattern": "^[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*$" } }, + "com.amazonaws.migrationhuborchestrator#TemplateSource": { + "type": "union", + "members": { + "workflowId": { + "target": "com.amazonaws.migrationhuborchestrator#MigrationWorkflowId", + "traits": { + "smithy.api#documentation": "The ID of the workflow from the source migration workflow template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The migration workflow template used as the source for the new template.
" + } + }, "com.amazonaws.migrationhuborchestrator#TemplateStatus": { "type": "string", "traits": { @@ -4156,6 +4423,22 @@ { "value": "CREATED", "name": "CREATED" + }, + { + "value": "READY", + "name": "READY" + }, + { + "value": "PENDING_CREATION", + "name": "PENDING_CREATION" + }, + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "CREATION_FAILED", + "name": "CREATION_FAILED" } ] } @@ -4559,6 +4842,111 @@ } } }, + "com.amazonaws.migrationhuborchestrator#UpdateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateTemplateRequest" + }, + "output": { + "target": "com.amazonaws.migrationhuborchestrator#UpdateTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhuborchestrator#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhuborchestrator#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a migration workflow template.
", + "smithy.api#http": { + "method": "POST", + "uri": "/template/{id}", + "code": 200 + } + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhuborchestrator#TemplateId", + "traits": { + "smithy.api#documentation": "The ID of the request to update a migration workflow template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "templateName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the migration workflow template to update.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[ a-zA-Z0-9]*$" + } + }, + "templateDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the migration workflow template to update.
", + "smithy.api#length": { + "min": 0, + "max": 250 + }, + "smithy.api#pattern": "^.*$" + } + }, + "clientToken": { + "target": "com.amazonaws.migrationhuborchestrator#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the\n idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.migrationhuborchestrator#UpdateTemplateResponse": { + "type": "structure", + "members": { + "templateId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the migration workflow template being updated.
" + } + }, + "templateArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the migration workflow template being updated. The format for an Migration Hub Orchestrator\n template ARN is\n arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the AWS General Reference.
The tags added to the migration workflow template.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.migrationhuborchestrator#UpdateWorkflow": { "type": "operation", "input": { @@ -5081,13 +5469,13 @@ } }, "stringValue": { - "target": "com.amazonaws.migrationhuborchestrator#StringValue", + "target": "com.amazonaws.migrationhuborchestrator#MaxStringValue", "traits": { "smithy.api#documentation": "The string value.
" } }, "listOfStringValue": { - "target": "com.amazonaws.migrationhuborchestrator#StringList", + "target": "com.amazonaws.migrationhuborchestrator#MaxStringList", "traits": { "smithy.api#documentation": "The list of string value.
" } diff --git a/codegen/sdk-codegen/aws-models/mwaa.2020-07-01.json b/codegen/sdk-codegen/aws-models/mwaa.2020-07-01.json index f63c1fad3c7..7e15e90fa92 100644 --- a/codegen/sdk-codegen/aws-models/mwaa.2020-07-01.json +++ b/codegen/sdk-codegen/aws-models/mwaa.2020-07-01.json @@ -1133,7 +1133,7 @@ "AirflowVersion": { "target": "com.amazonaws.mwaa#AirflowVersion", "traits": { - "smithy.api#documentation": "The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version.\n For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
\nValid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2\n
The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version.\n For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
\nValid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2\n 2.8.1\n
The unique identifier (ID) associated with this OU.
\nThe regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.
" + "smithy.api#documentation": "The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
\nThe regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.
" } }, "Arn": { @@ -7671,8 +7753,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 1000000 + "min": 1 }, "smithy.api#pattern": "^[\\s\\S]*$" } @@ -8255,7 +8336,7 @@ "Id": { "target": "com.amazonaws.organizations#RootId", "traits": { - "smithy.api#documentation": "The unique identifier (ID) for the root.
\nThe regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.
" + "smithy.api#documentation": "The unique identifier (ID) for the root. The ID is unique to the organization only.
\nThe regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.
" } }, "Arn": { diff --git a/codegen/sdk-codegen/aws-models/payment-cryptography-data.2022-02-03.json b/codegen/sdk-codegen/aws-models/payment-cryptography-data.2022-02-03.json index ec944770c08..b4d185a3ffa 100644 --- a/codegen/sdk-codegen/aws-models/payment-cryptography-data.2022-02-03.json +++ b/codegen/sdk-codegen/aws-models/payment-cryptography-data.2022-02-03.json @@ -313,7 +313,7 @@ } ], "traits": { - "smithy.api#documentation": "Decrypts ciphertext data to plaintext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.
\nYou can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.
For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA. When you use DUKPT, for TDES algorithm, the ciphertext data length must be a multiple of 16 bytes. For AES algorithm, the ciphertext data length must be a multiple of 32 bytes.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n EncryptData\n
\n\n GetPublicCertificate\n
\n\n ImportKey\n
\nDecrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.
\nYou can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.
For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.
When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n EncryptData\n
\n\n GetPublicCertificate\n
\n\n ImportKey\n
\nThe key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, "PlainText": { "target": "com.amazonaws.paymentcryptographydata#HexEvenLengthBetween16And4096", "traits": { - "smithy.api#documentation": "The decrypted plaintext data.
", + "smithy.api#documentation": "The decrypted plaintext data in hexBinary format.
", "smithy.api#required": {} } } @@ -498,7 +498,7 @@ "Mode": { "target": "com.amazonaws.paymentcryptographydata#DukptEncryptionMode", "traits": { - "smithy.api#documentation": "The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
\nThe default is CBC.
" + "smithy.api#documentation": "The block cipher method to use for encryption.
\nThe default is CBC.
" } }, "DukptKeyDerivationType": { @@ -516,7 +516,7 @@ "InitializationVector": { "target": "com.amazonaws.paymentcryptographydata#HexLength16Or32", "traits": { - "smithy.api#documentation": "An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" } } }, @@ -630,6 +630,84 @@ "smithy.api#documentation": "Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" } }, + "com.amazonaws.paymentcryptographydata#EmvEncryptionAttributes": { + "type": "structure", + "members": { + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#EmvMajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.
", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "SessionDerivationData": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals16", + "traits": { + "smithy.api#documentation": "The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.
", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.paymentcryptographydata#EmvEncryptionMode", + "traits": { + "smithy.api#documentation": "The block cipher method to use for encryption.
" + } + }, + "InitializationVector": { + "target": "com.amazonaws.paymentcryptographydata#HexLength16Or32", + "traits": { + "smithy.api#documentation": "An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters for plaintext encryption using EMV keys.
" + } + }, + "com.amazonaws.paymentcryptographydata#EmvEncryptionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ECB", + "name": "ECB" + }, + { + "value": "CBC", + "name": "CBC" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#EmvMajorKeyDerivationMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EMV_OPTION_A", + "name": "EMV_OPTION_A" + }, + { + "value": "EMV_OPTION_B", + "name": "EMV_OPTION_B" + } + ] + } + }, "com.amazonaws.paymentcryptographydata#EncryptData": { "type": "operation", "input": { @@ -656,7 +734,7 @@ } ], "traits": { - "smithy.api#documentation": "Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
\nYou can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey).
for symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. To encrypt using DUKPT, you must already have a DUKPT key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DecryptData\n
\n\n GetPublicCertificate\n
\n\n ImportKey\n
\n\n ReEncryptData\n
\nEncrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
\nYou can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.
When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.
\nTo encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DecryptData\n
\n\n GetPublicCertificate\n
\n\n ImportKey\n
\n\n ReEncryptData\n
\nThe plaintext to be encrypted.
", + "smithy.api#documentation": "The plaintext to be encrypted.
\nFor encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
" + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" } }, "CipherText": { @@ -736,6 +814,12 @@ }, "Dukpt": { "target": "com.amazonaws.paymentcryptographydata#DukptEncryptionAttributes" + }, + "Emv": { + "target": "com.amazonaws.paymentcryptographydata#EmvEncryptionAttributes", + "traits": { + "smithy.api#documentation": "Parameters for plaintext encryption using EMV keys.
" + } } }, "traits": { @@ -863,7 +947,7 @@ "KeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, @@ -905,7 +989,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
\nYou can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for comparision without sending or receiving data in ciphertext or plaintext. You can use this operation to generate a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set to Generate and Verify.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n VerifyMac\n
\nGenerates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
\nYou can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision.
\nYou can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set to Generate and Verify.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n VerifyMac\n
\nThe data for which a MAC is under generation.
", + "smithy.api#documentation": "The data for which a MAC is under generation. This value must be hexBinary.
", "smithy.api#required": {} } }, @@ -961,7 +1045,7 @@ "KeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, @@ -1074,7 +1158,7 @@ "GenerationKeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, @@ -1088,7 +1172,7 @@ "EncryptionKeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, @@ -1494,7 +1578,6 @@ "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And12": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 4, "max": 12 @@ -1683,7 +1766,7 @@ "DukptIso9797Algorithm3": { "target": "com.amazonaws.paymentcryptographydata#MacAlgorithmDukpt", "traits": { - "smithy.api#documentation": "Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
" + "smithy.api#documentation": "Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
" } }, "DukptCmac": { @@ -2713,7 +2796,7 @@ "KeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, @@ -2991,14 +3074,14 @@ "Mode": { "target": "com.amazonaws.paymentcryptographydata#EncryptionMode", "traits": { - "smithy.api#documentation": "The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
", + "smithy.api#documentation": "The block cipher method to use for encryption.
", "smithy.api#required": {} } }, "InitializationVector": { "target": "com.amazonaws.paymentcryptographydata#HexLength16Or32", "traits": { - "smithy.api#documentation": "An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" } }, "PaddingType": { @@ -3051,7 +3134,7 @@ } ], "traits": { - "smithy.api#documentation": "Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.
\nPIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT tranlations. You can use this operation for P2PE (Point to Point Encryption) use cases where the encryption keys should change but the processing system either does not need to, or is not permitted to, decrypt the data.
The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\nAt this time, Amazon Web Services Payment Cryptography does not support translations to PIN format 4.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n GeneratePinData\n
\n\n VerifyPinData\n
\nTranslates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.
\nPIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT translations.
The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\nAmazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n GeneratePinData\n
\n\n VerifyPinData\n
\nThe format of the incoming PIN block data for tranlation within Amazon Web Services Payment Cryptography.
", + "smithy.api#documentation": "The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.
", "smithy.api#required": {} } }, "OutgoingTranslationAttributes": { "target": "com.amazonaws.paymentcryptographydata#TranslationIsoFormats", "traits": { - "smithy.api#documentation": "The format of the outgoing PIN block data after tranlation by Amazon Web Services Payment Cryptography.
", + "smithy.api#documentation": "The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.
", "smithy.api#required": {} } }, @@ -3100,7 +3183,7 @@ "IncomingDukptAttributes": { "target": "com.amazonaws.paymentcryptographydata#DukptDerivationAttributes", "traits": { - "smithy.api#documentation": "The attributes and values to use for incoming DUKPT encryption key for PIN block tranlation.
" + "smithy.api#documentation": "The attributes and values to use for incoming DUKPT encryption key for PIN block translation.
" } }, "OutgoingDukptAttributes": { @@ -3120,7 +3203,7 @@ "PinBlock": { "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32", "traits": { - "smithy.api#documentation": "The ougoing encrypted PIN block data after tranlation.
", + "smithy.api#documentation": "The outgoing encrypted PIN block data after translation.
", "smithy.api#required": {} } }, @@ -3134,7 +3217,7 @@ "KeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } } @@ -3391,7 +3474,7 @@ "KeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, @@ -3492,7 +3575,7 @@ "KeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } } @@ -3530,7 +3613,7 @@ } ], "traits": { - "smithy.api#documentation": "Verifies a Message Authentication Code (MAC).
\nYou can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for verification without sending or receiving data in ciphertext or plaintext. You can use this operation to verify a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. Use the same encryption key for MAC verification as you use for GenerateMac.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n GenerateMac\n
\nVerifies a Message Authentication Code (MAC).
\nYou can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n GenerateMac\n
\nThe data on for which MAC is under verification.
", + "smithy.api#documentation": "The data on for which MAC is under verification. This value must be hexBinary.
", "smithy.api#required": {} } }, @@ -3593,7 +3676,7 @@ "KeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } } @@ -3715,7 +3798,7 @@ "VerificationKeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } }, @@ -3729,7 +3812,7 @@ "EncryptionKeyCheckValue": { "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", "traits": { - "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
\nAmazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index 7ab4cf82fb7..462a74e9a61 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -5091,7 +5091,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 200 + "max": 2000 } } }, @@ -5593,6 +5593,12 @@ "traits": { "smithy.api#documentation": "The aggregation function of the column tooltip item.
" } + }, + "TooltipTarget": { + "target": "com.amazonaws.quicksight#TooltipTarget", + "traits": { + "smithy.api#documentation": "Determines the target of the column tooltip item in a combo chart visual.
" + } } }, "traits": { @@ -21404,6 +21410,12 @@ "traits": { "smithy.api#documentation": "The visibility of the tooltip item.
" } + }, + "TooltipTarget": { + "target": "com.amazonaws.quicksight#TooltipTarget", + "traits": { + "smithy.api#documentation": "Determines the target of the field tooltip item in a combo chart visual.
" + } } }, "traits": { @@ -23788,7 +23800,7 @@ "AuthorizedResourceArns": { "target": "com.amazonaws.quicksight#ArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session. If you choose\n Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view. Currently, you can pass up to 25\n dashboard ARNs in each API call.
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session.
\nIf you choose Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view.
Currently, you can pass up to 25\n dashboard ARNs in each API call.
", "smithy.api#required": {} } }, @@ -45992,6 +46004,29 @@ "smithy.api#documentation": "The display options for the visual tooltip.
" } }, + "com.amazonaws.quicksight#TooltipTarget": { + "type": "enum", + "members": { + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTH" + } + }, + "BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAR" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + } + } + }, "com.amazonaws.quicksight#TooltipTitleType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json index f4b725baa44..2b818b87e41 100644 --- a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json @@ -2970,6 +2970,9 @@ "traits": { "smithy.api#documentation": "The storage type for the DB cluster.
" } + }, + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails" } }, "traits": { @@ -4391,7 +4394,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The storage type to associate with the DB cluster.
\nFor information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.
\nThis setting is required to create a Multi-AZ DB cluster.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\nAurora DB clusters - aurora | aurora-iopt1\n
Multi-AZ DB clusters - io1\n
Default:
\nAurora DB clusters - aurora\n
Multi-AZ DB clusters - io1\n
When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to aurora.
The storage type to associate with the DB cluster.
\nFor information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.
\nThis setting is required to create a Multi-AZ DB cluster.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\nAurora DB clusters - aurora | aurora-iopt1\n
Multi-AZ DB clusters - io1 | io2 | gp3\n
Default:
\nAurora DB clusters - aurora\n
Multi-AZ DB clusters - io1\n
When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to aurora.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The CA certificate identifier to use for the DB cluster's server certificate.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters
" + } } }, "traits": { @@ -4899,7 +4908,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 64000.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1, io2):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe storage type to associate with the DB instance.
\nIf you specify io1 or gp3, you must also include a value for the\n Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
\nValid Values: gp2 | gp3 | io1 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
The storage type to associate with the DB instance.
\nIf you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
\nValid Values: gp2 | gp3 | io1 | io2 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
The storage type to associate with the read replica.
\nIf you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Valid Values: gp2 | gp3 | io1 | standard\n
Default: io1 if the Iops parameter\n is specified. Otherwise, gp2.
The storage type to associate with the read replica.
\nIf you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.
Valid Values: gp2 | gp3 | io1 | io2 | standard\n
Default: io1 if the Iops parameter\n is specified. Otherwise, gp2.
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } + }, + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails" } }, "traits": { @@ -21558,7 +21570,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The storage type to associate with the DB cluster.
\nFor information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\nAurora DB clusters - aurora | aurora-iopt1\n
Multi-AZ DB clusters - io1\n
Default:
\nAurora DB clusters - aurora\n
Multi-AZ DB clusters - io1\n
The storage type to associate with the DB cluster.
\nFor information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\nAurora DB clusters - aurora | aurora-iopt1\n
Multi-AZ DB clusters - io1 | io2 | gp3\n
Default:
\nAurora DB clusters - aurora\n
Multi-AZ DB clusters - io1\n
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
\nValid for: Aurora DB clusters only
" } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The CA certificate identifier to use for the DB cluster's server certificate.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters
" + } } }, "traits": { @@ -22093,7 +22111,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The storage type to associate with the DB instance.
\nIf you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
The storage type to associate with the DB instance.
\nIf you specify io1, io2, or gp3 \n you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nValid Values: gp2 | gp3 | io1 | io2 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
Specifies the storage type to be associated with the DB instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid Values: gp2 | gp3 | io1 | io2 | standard\n
If you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, \n you must also include a value for the Iops parameter.
Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid Values: gp2 | gp3 | io1 | io2 | standard\n
If you specify io1, io2, or gp3, \n you must also include a value for the Iops parameter.
Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n
The storage type to associate with the DB instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
Constraints:
\nIf you specify io1 or gp3, you must also include a value for the\n Iops parameter.
The storage type to associate with the DB instance.
\nValid Values: gp2 | gp3 | io1 | io2 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
Constraints:
\nIf you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.
The valid storage types for your DB instance.\n For example: gp2, gp3, io1.
" + "smithy.api#documentation": "The valid storage types for your DB instance.\n For example: gp2, gp3, io1, io2.
" } }, "StorageSize": { diff --git a/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json b/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json index 5dbca5f4e1e..f7a46dd42fa 100644 --- a/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json +++ b/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json @@ -338,7 +338,7 @@ "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare that the consumer is to use.
", "smithy.api#required": {} } }, @@ -351,7 +351,7 @@ "ConsumerArn": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumer that is associated with the\n datashare.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumer namespace associated with the\n datashare.
" } }, "ConsumerRegion": { @@ -707,7 +707,7 @@ "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare that producers are to authorize\n sharing for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare namespace that producers are to authorize\n sharing for.
", "smithy.api#required": {} } }, @@ -843,7 +843,7 @@ "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
" + "smithy.api#documentation": "The identifier of the cluster the snapshot was created from.
\n\n If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all (*) snapshots - This parameter is required. Otherwise, permissions \n aren't available to check if the snapshot exists.
\n\n If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the cluster identifier and use it to \n validate snapshot authorization.
\nThe port number on which the cluster accepts incoming connections.
\nThe cluster is accessible only via the JDBC and ODBC connection strings. Part of\n the connection string requires the port on which the cluster will listen for incoming\n connections.
\nDefault: 5439\n
Valid Values: 1150-65535\n
The port number on which the cluster accepts incoming connections.
\nThe cluster is accessible only via the JDBC and ODBC connection strings. Part of\n the connection string requires the port on which the cluster will listen for incoming\n connections.
\nDefault: 5439\n
Valid Values:\n
\nFor clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster \n with ra3 nodes, it isn't required that you change the port to these ranges.)
For clusters with ds2 or dc2 nodes - Select a port within the range 1150-65535.
An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.
The Amazon Resource Name (ARN) of the datashare that the consumer is to use.
" } }, "ProducerArn": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the producer.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the producer namespace.
" } }, "AllowPubliclyAccessibleConsumers": { @@ -4667,7 +4667,7 @@ "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare to remove authorization from.
", + "smithy.api#documentation": "The namespace Amazon Resource Name (ARN) of the datashare to remove authorization from.
", "smithy.api#required": {} } }, @@ -6502,7 +6502,7 @@ "ConsumerArn": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.
" } }, "Status": { @@ -6577,7 +6577,7 @@ "ProducerArn": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares.
" } }, "Status": { @@ -6629,7 +6629,7 @@ "DataShareArn": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the datashare to describe details of.
" + "smithy.api#documentation": "The Amazon resource name (ARN) of the datashare to describe details of.
" } }, "MaxRecords": { @@ -8350,7 +8350,7 @@ "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare to remove association for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare to remove association for.
", "smithy.api#required": {} } }, @@ -8363,7 +8363,7 @@ "ConsumerArn": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumer that association for\n the datashare is removed from.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumer namespace that association for\n the datashare is removed from.
" } }, "ConsumerRegion": { @@ -11585,7 +11585,7 @@ "Port": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "The option to change the port of an Amazon Redshift cluster.
" + "smithy.api#documentation": "The option to change the port of an Amazon Redshift cluster.
\nValid Values:\n
\nFor clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster \n with ra3 nodes, it isn't required that you change the port to these ranges.)
For clusters with ds2 or dc2 nodes - Select a port within the range 1150-65535.
The port number on which the cluster accepts connections.
\nDefault: The same port as the original cluster.
\nConstraints: Must be between 1115 and 65535.
The port number on which the cluster accepts connections.
\nDefault: The same port as the original cluster.
\nValid values: For clusters with ds2 or dc2 nodes, must be within the range 1150-65535. For clusters with ra3 nodes, must be \n within the ranges 5431-5455 or 8191-8215.
The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.
\nThe list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.
\nFor tabular problem types:
\nList of available metrics:
\n Regression: InferenceLatency, MAE,\n MSE, R2, RMSE\n
Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n InferenceLatency, LogLoss,\n Precision, Recall\n
Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n InferenceLatency, LogLoss,\n PrecisionMacro, RecallMacro\n
For a description of each metric, see Autopilot metrics for classification and regression.
\nDefault objective metrics:
\nRegression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types:
\nList of available metrics: Accuracy\n
For a description of each metric, see Autopilot metrics for text and image classification.
\nDefault objective metrics: Accuracy\n
For time-series forecasting problem types:
\nList of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n
For a description of each metric, see Autopilot metrics for\n time-series forecasting.
\nDefault objective metrics: AverageWeightedQuantileLoss\n
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.
\nThe list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.
\nFor tabular problem types:
\nList of available metrics:
\n Regression: MAE,\n MSE, R2, RMSE\n
Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n Precision, Recall\n
Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n PrecisionMacro, RecallMacro\n
For a description of each metric, see Autopilot metrics for classification and regression.
\nDefault objective metrics:
\nRegression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types:
\nList of available metrics: Accuracy\n
For a description of each metric, see Autopilot metrics for text and image classification.
\nDefault objective metrics: Accuracy\n
For time-series forecasting problem types:
\nList of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n
For a description of each metric, see Autopilot metrics for\n time-series forecasting.
\nDefault objective metrics: AverageWeightedQuantileLoss\n
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.
\nUse this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.
\nTo host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.
For an example that calls this method when deploying a model to SageMaker hosting services,\n see Create a Model (Amazon Web Services SDK for Python (Boto 3)).\n
\nTo run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
" + "smithy.api#documentation": "Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.
\nUse this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.
\nTo host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.
To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
" } }, "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { @@ -10982,7 +10982,7 @@ "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "Specifies details about inference jobs that can be run with models based on this model\n package, including the following:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nSpecifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nIndicates if you want to skip model validation.
" } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "The URI of the source for the model package. If you want to clone a model package,\n set it to the model package Amazon Resource Name (ARN). If you want to register a model,\n set it to the model ARN.
" + } } }, "traits": { @@ -16241,7 +16247,7 @@ "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "The creation time.
" + "smithy.api#documentation": "The creation time of the application.
\nAfter an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.
\nDetails about inference jobs that can be run with models based on this model\n package.
" + "smithy.api#documentation": "Details about inference jobs that you can run with models based on this model\n package.
" } }, "SourceAlgorithmSpecification": { @@ -21217,6 +21223,12 @@ "traits": { "smithy.api#documentation": "Indicates if you want to skip model validation.
" } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "The URI of the source for the model package.
" + } } }, "traits": { @@ -26115,7 +26127,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 16 + "max": 100 } } }, @@ -32698,7 +32710,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app.
" + "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app. The FileSystemConfig object is not supported.
Metrics that measure bais in a model.
" + "smithy.api#documentation": "Metrics that measure bias in a model.
" } }, "Explainability": { @@ -43210,6 +43222,12 @@ "smithy.api#documentation": "An array of additional Inference Specification objects.
" } }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "The URI of the source for the model package.
" + } + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -43290,6 +43308,12 @@ "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same region as the\n model package.
\nSpecifies the location of ML model data to deploy during endpoint creation.
" + } + }, "ProductId": { "target": "com.amazonaws.sagemaker#ProductId", "traits": { @@ -43543,6 +43567,16 @@ } } }, + "com.amazonaws.sagemaker#ModelPackageSourceUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}$" + } + }, "com.amazonaws.sagemaker#ModelPackageStatus": { "type": "enum", "members": { @@ -56729,6 +56763,12 @@ "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services\n region as the algorithm.
\nSpecifies the location of ML model data to deploy during endpoint creation.
" + } + }, "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { @@ -63301,7 +63341,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the feature group by either adding features or updating the online store\n configuration. Use one of the following request parameters at a time while using the\n UpdateFeatureGroup API.
You can add features for your feature group using the FeatureAdditions\n request parameter. Features cannot be removed from a feature group.
You can update the online store configuration by using the\n OnlineStoreConfig request parameter. If a TtlDuration is\n specified, the default TtlDuration applies for all records added to the\n feature group after the feature group is updated. If a record level\n TtlDuration exists from using the PutRecord API, the record\n level TtlDuration applies to that record instead of the default\n TtlDuration.
Updates the feature group by either adding features or updating the online store\n configuration. Use one of the following request parameters at a time while using the\n UpdateFeatureGroup API.
You can add features for your feature group using the FeatureAdditions\n request parameter. Features cannot be removed from a feature group.
You can update the online store configuration by using the\n OnlineStoreConfig request parameter. If a TtlDuration is\n specified, the default TtlDuration applies for all records added to the\n feature group after the feature group is updated. If a record level\n TtlDuration exists from using the PutRecord API, the record\n level TtlDuration applies to that record instead of the default\n TtlDuration. To remove the default TtlDuration from an\n existing feature group, use the UpdateFeatureGroup API and set the\n TtlDuration\n Unit and Value to null.
An array of additional Inference Specification objects to be added to the \n existing array additional Inference Specification. Total number of additional \n Inference Specifications can not exceed 15. Each additional Inference Specification \n specifies artifacts based on this model package that can be used on inference endpoints. \n Generally used with SageMaker Neo to store the compiled artifacts.
" } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nThe URI of the source for the model package.
" + } } }, "traits": { @@ -65587,7 +65639,7 @@ "Key": { "target": "com.amazonaws.sagemaker#VisibilityConditionsKey", "traits": { - "smithy.api#documentation": "The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags..
The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags..
The list of key-value pairs that you specify for your resources.
" + "smithy.api#documentation": "The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. \n If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.
" } }, "com.amazonaws.sagemaker#VisibilityConditionsKey": { diff --git a/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json b/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json index ed5fb4aed87..65c98b004b7 100644 --- a/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json @@ -137,7 +137,7 @@ }, "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 50 } } @@ -180,6 +180,18 @@ "traits": { "smithy.api#enumValue": "S3_DATA" } + }, + "EKS_AUDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT" + } + }, + "WAF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAF" + } } } }, @@ -207,6 +219,11 @@ "type": "list", "member": { "target": "com.amazonaws.securitylake#AwsLogSourceResource" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } } }, "com.amazonaws.securitylake#AwsLogSourceVersion": { @@ -416,7 +433,8 @@ "configuration": { "target": "com.amazonaws.securitylake#CustomLogSourceConfiguration", "traits": { - "smithy.api#documentation": "The configuration for the third-party custom source.
" + "smithy.api#documentation": "The configuration for the third-party custom source.
", + "smithy.api#required": {} } } }, @@ -626,8 +644,7 @@ "autoEnableNewAccount": { "target": "com.amazonaws.securitylake#DataLakeAutoEnableNewAccountConfigurationList", "traits": { - "smithy.api#documentation": "Enable Security Lake with the specified configuration settings, to begin collecting security\n data for new accounts in your organization.
", - "smithy.api#required": {} + "smithy.api#documentation": "Enable Security Lake with the specified configuration settings, to begin collecting security\n data for new accounts in your organization.
" } } }, @@ -1113,6 +1130,11 @@ "type": "list", "member": { "target": "com.amazonaws.securitylake#DataLakeAutoEnableNewAccountConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } } }, "com.amazonaws.securitylake#DataLakeConfiguration": { @@ -1152,6 +1174,11 @@ "type": "list", "member": { "target": "com.amazonaws.securitylake#DataLakeConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } } }, "com.amazonaws.securitylake#DataLakeEncryptionConfiguration": { @@ -1779,8 +1806,7 @@ "autoEnableNewAccount": { "target": "com.amazonaws.securitylake#DataLakeAutoEnableNewAccountConfigurationList", "traits": { - "smithy.api#documentation": "Turns off automatic enablement of Security Lake for member accounts that are added to an organization.
", - "smithy.api#required": {} + "smithy.api#documentation": "Turns off automatic enablement of Security Lake for member accounts that are added to an organization.
" } } }, @@ -2817,7 +2843,7 @@ "resourceArn": { "target": "com.amazonaws.securitylake#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Security Lake resource to retrieve the tags for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Security Lake resource for which you want to retrieve the tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3073,7 +3099,7 @@ "com.amazonaws.securitylake#RoleArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:.*$" + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, "com.amazonaws.securitylake#S3BucketArn": { @@ -4490,6 +4516,12 @@ "smithy.api#documentation": "Specify the Region or Regions that will contribute data to the rollup region.
", "smithy.api#required": {} } + }, + "metaStoreManagerRoleArn": { + "target": "com.amazonaws.securitylake#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) used to create and update the Glue table.\n This table contains partitions generated by the ingestion and normalization of\n Amazon Web Services log sources and custom sources.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json b/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json index 85eca1091f7..68f31c8d7dc 100644 --- a/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json +++ b/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json @@ -870,7 +870,7 @@ "ContactListImportAction": { "target": "com.amazonaws.sesv2#ContactListImportAction", "traits": { - "smithy.api#documentation": ">The type of action to perform on the addresses. The following are the \n possible values:
\nPUT: add the addresses to the contact list. If the record already exists, it\n will override it with the new value.
\nDELETE: remove the addresses from the contact list.
\n>The type of action to perform on the addresses. The following are the possible\n values:
\nPUT: add the addresses to the contact list. If the record already exists, it\n will override it with the new value.
\nDELETE: remove the addresses from the contact list.
\nSpecifies the status of your VDM engagement metrics collection. Can be one of the following:
\n\n ENABLED – Amazon SES enables engagement metrics for your account.
\n DISABLED – Amazon SES disables engagement metrics for your account.
Specifies the status of your VDM engagement metrics collection. Can be one of the\n following:
\n\n ENABLED – Amazon SES enables engagement metrics for your\n account.
\n DISABLED – Amazon SES disables engagement metrics for your\n account.
An object containing additional settings for your VDM configuration as applicable to the Dashboard.
" + "smithy.api#documentation": "An object containing additional settings for your VDM configuration as applicable to\n the Dashboard.
" } }, "com.amazonaws.sesv2#DashboardOptions": { @@ -3276,7 +3276,7 @@ "Raw": { "target": "com.amazonaws.sesv2#RawMessage", "traits": { - "smithy.api#documentation": "The raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nIf you include attachments, they must be in a file format that the Amazon SES API v2\n supports.\n
\nThe raw data of the message needs to base64-encoded if you are accessing\n Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nThe raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nIf you include attachments, they must be in a file format that the Amazon SES API v2\n supports.\n
\nThe raw data of the message needs to base64-encoded if you are accessing Amazon SES\n directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nIndicates whether or not your account has production access in the current Amazon Web Services\n Region.
\nIf the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.
If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.
Indicates whether or not your account has production access in the current Amazon Web Services\n Region.
\nIf the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities.\n
If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.
Specifies the status of your VDM optimized shared delivery. Can be one of the following:
\n\n ENABLED – Amazon SES enables optimized shared delivery for your account.
\n DISABLED – Amazon SES disables optimized shared delivery for your account.
Specifies the status of your VDM optimized shared delivery. Can be one of the\n following:
\n\n ENABLED – Amazon SES enables optimized shared delivery for your\n account.
\n DISABLED – Amazon SES disables optimized shared delivery for\n your account.
An object containing additional settings for your VDM configuration as applicable to the Guardian.
" + "smithy.api#documentation": "An object containing additional settings for your VDM configuration as applicable to\n the Guardian.
" } }, "com.amazonaws.sesv2#GuardianOptions": { @@ -6327,7 +6327,7 @@ "PageSize": { "target": "com.amazonaws.sesv2#MaxItems", "traits": { - "smithy.api#documentation": "The number of contacts that may be returned at once, which is dependent on if there\n are more or less contacts than the value of the PageSize. Use this parameter to\n paginate results. If additional contacts exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent requests to retrieve additional\n contacts.
The number of contacts that may be returned at once, which is dependent on if there\n are more or less contacts than the value of the PageSize. Use this parameter to paginate\n results. If additional contacts exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent requests to retrieve additional\n contacts.
The body of the message. You can specify an HTML version of the message, a text-only\n version of the message, or both.
", "smithy.api#required": {} } + }, + "Headers": { + "target": "com.amazonaws.sesv2#MessageHeaderList", + "traits": { + "smithy.api#documentation": "The list of message headers that will be added to the email message.
" + } } }, "traits": { @@ -7483,6 +7489,63 @@ "com.amazonaws.sesv2#MessageData": { "type": "string" }, + "com.amazonaws.sesv2#MessageHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sesv2#MessageHeaderName", + "traits": { + "smithy.api#documentation": "The name of the message header. The message header name has to meet the following\n criteria:
\nCan contain any printable ASCII character (33 - 126) except for colon (:).
\nCan contain no more than 126 characters.
\nThe value of the message header. The message header value has to meet the following\n criteria:
\nCan contain any printable ASCII character.
\nCan contain no more than 870 characters.
\nContains the name and value of a message header that you add to an email.
" + } + }, + "com.amazonaws.sesv2#MessageHeaderList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#MessageHeader" + }, + "traits": { + "smithy.api#documentation": "A list of message headers. The list of message headers has to meet the following\n criteria:
\nCan contain no more than 15 headers in one message.
\nThe name of the message header. The message header name has to meet the following\n criteria:
\nCan contain any printable ASCII character (33 - 126) except for colon (:).
\nCan contain no more than 126 characters.
\nThe value of the message header. The message header value has to meet the following\n criteria:
\nCan contain any printable ASCII character.
\nIndicates whether or not your account should have production access in the current\n Amazon Web Services Region.
\nIf the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.
If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.
Indicates whether or not your account should have production access in the current\n Amazon Web Services Region.
\nIf the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities.\n
If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.
The raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nAttachments must be in a file format that the Amazon SES supports.
\nThe raw data of the message needs to base64-encoded if you are accessing\n Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nThe raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nAttachments must be in a file format that the Amazon SES supports.
\nThe raw data of the message needs to base64-encoded if you are accessing Amazon SES\n directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nThe email address to use as the \"From\" address for the email. The\n address that you specify has to be verified.
" + "smithy.api#documentation": "The email address to use as the \"From\" address for the email. The address that you\n specify has to be verified.
" } }, "FromEmailAddressIdentityArn": { @@ -9927,7 +9990,7 @@ "FromEmailAddress": { "target": "com.amazonaws.sesv2#EmailAddress", "traits": { - "smithy.api#documentation": "The email address to use as the \"From\" address for the email. The\n address that you specify has to be verified.\n
" + "smithy.api#documentation": "The email address to use as the \"From\" address for the email. The address that you\n specify has to be verified.\n
" } }, "FromEmailAddressIdentityArn": { @@ -9963,7 +10026,7 @@ "Content": { "target": "com.amazonaws.sesv2#EmailContent", "traits": { - "smithy.api#documentation": "An object that contains the body of the message. You can send either a Simple message\n Raw message or a template Message.
", + "smithy.api#documentation": "An object that contains the body of the message. You can send either a Simple message,\n Raw message, or a Templated message.
", "smithy.api#required": {} } }, @@ -9997,7 +10060,7 @@ "MessageId": { "target": "com.amazonaws.sesv2#OutboundMessageId", "traits": { - "smithy.api#documentation": "A unique identifier for the message that is generated when the message is\n accepted.
\nIt's possible for Amazon SES to accept a message without sending it. This can happen\n when the message that you're trying to send has an attachment contains a virus, or\n when you send a templated email that contains invalid personalization content, for\n example.
\nA unique identifier for the message that is generated when the message is\n accepted.
\nIt's possible for Amazon SES to accept a message without sending it. For example, this\n can happen when the message that you're trying to send has an attachment that\n contains a virus, or when you send a templated email that contains invalid\n personalization content.
\nAn object that defines the values to use for message variables in the template. This\n object is a set of key-value pairs. Each key defines a message variable in the template.\n The corresponding value defines the value to use for that variable.
" } + }, + "Headers": { + "target": "com.amazonaws.sesv2#MessageHeaderList", + "traits": { + "smithy.api#documentation": "The list of message headers that will be added to the email message.
" + } } }, "traits": { @@ -12021,7 +12090,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a contact's preferences for a list. It is not necessary to specify all\n existing topic preferences in the TopicPreferences object, just the ones that need\n updating.
", + "smithy.api#documentation": "Updates a contact's preferences for a list.
\nYou must specify all existing topic preferences in the\n TopicPreferences object, not just the ones that need updating;\n otherwise, all your existing preferences will be removed.
Specifies additional settings for your VDM configuration as applicable to the Dashboard.
" + "smithy.api#documentation": "Specifies additional settings for your VDM configuration as applicable to the\n Dashboard.
" } }, "GuardianAttributes": { "target": "com.amazonaws.sesv2#GuardianAttributes", "traits": { - "smithy.api#documentation": "Specifies additional settings for your VDM configuration as applicable to the Guardian.
" + "smithy.api#documentation": "Specifies additional settings for your VDM configuration as applicable to the\n Guardian.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json b/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json index c9a1cc8d043..a4ead5bb07a 100644 --- a/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json +++ b/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json @@ -2758,7 +2758,7 @@ "EKSAnywhereVersion": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "The version of EKS Anywhere on the Snow Family device.
" + "smithy.api#documentation": "The optional version of EKS Anywhere on the Snow Family device.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json index 138a2a7f110..8b653c0ee36 100644 --- a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json +++ b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json @@ -94,7 +94,7 @@ "EncryptionAlgorithm": { "target": "com.amazonaws.transfer#EncryptionAlg", "traits": { - "smithy.api#documentation": "The algorithm that is used to encrypt the file.
\nYou can only specify NONE if the URL for your connector uses HTTPS. This ensures that\n no traffic is sent in clear text.
The algorithm that is used to encrypt the file.
\nNote the following:
\nDo not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.
You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that\n no traffic is sent in clear text.
Creates the connector, which captures the parameters for a connection for the\n AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.\n For more details about connectors, see Create AS2 connectors and Create SFTP connectors.
\nYou must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).
Creates the connector, which captures the parameters for a connection for the\n AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.\n For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.
\nYou must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).
A list of address allocation IDs that are required to attach an Elastic IP address to your\n server's endpoint.
\nThis property can only be set when EndpointType is set to VPC\n and it is only valid in the UpdateServer API.
A list of address allocation IDs that are required to attach an Elastic IP address to your\n server's endpoint.
\nAn address allocation ID corresponds to the allocation ID of an Elastic IP address. This\n value can be retrieved from the allocationId field from the Amazon EC2\n Address\n data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.
This parameter is optional. Set this parameter if you want to make your VPC endpoint\n public-facing. For details, see Create an internet-facing endpoint for your server.
\nThis property can only be set as follows:
\n\n EndpointType must be set to\n VPC\n
The Transfer Family server must be offline.
\nYou cannot set this parameter for Transfer Family servers that use the FTP protocol.
\nThe server must already have SubnetIds populated (SubnetIds and AddressAllocationIds cannot be updated simultaneously).
\n AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. For example,\n if you have three subnet IDs, you must also specify three address allocation IDs.
Call the UpdateServer API to set or change this parameter.
The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element. Specify only the <key type> and <body\n base64>: do not enter the <comment> portion of the key.
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the <key type> string is ssh-rsa.
For ECDSA keys, the <key type> string is either\n ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.
The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element. Specify only the <key type> and <body\n base64>: do not enter the <comment> portion of the key.
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the <key type> string is ssh-rsa.
For ECDSA keys, the <key type> string is either\n ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.
Run this command to retrieve the SFTP server host key, where your SFTP server name is ftp.host.com.
\n ssh-keyscan ftp.host.com\n
This prints the public host key to standard output.
\n\n ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key\n
Copy and paste this string into the TrustedHostKeys field for the create-connector command or into the Trusted host keys field in the console.
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a\n partner's SFTP server.
" + "smithy.api#documentation": "Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a\n partner's SFTP server.
\nBecause the SftpConnectorConfig data type is used for both creating and updating SFTP connectors, its parameters,\n TrustedHostKeys and UserSecretId are marked as not required. This is a bit misleading, as they are not required when\n you are updating an existing SFTP connector, but are required when you are creating a new SFTP connector.
Assigns new properties to a user. Parameters you pass modify any or all of the following:\n the home directory, role, and policy for the UserName and ServerId\n you specify.
The response returns the ServerId and the UserName for the\n updated user.
Assigns new properties to a user. Parameters you pass modify any or all of the following:\n the home directory, role, and policy for the UserName and ServerId\n you specify.
The response returns the ServerId and the UserName for the\n updated user.
In the console, you can select Restricted when you create or update a\n user. This ensures that the user can't access anything outside of their home directory. The\n programmatic way to configure this behavior is to update the user. Set their\n HomeDirectoryType to LOGICAL, and specify\n HomeDirectoryMappings with Entry as root (/) and\n Target as their home directory.
For example, if the user's home directory is /test/admin-user, the following\n command updates the user so that their configuration in the console shows the\n Restricted flag as selected.
\n aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings \"[{\\\"Entry\\\":\\\"/\\\", \\\"Target\\\":\\\"/test/admin-user\\\"}]\"\n
Makes a series of decisions about multiple authorization requests for one principal or\n resource. Each request contains the equivalent content of an IsAuthorized\n request: principal, action, resource, and context. Either the principal or\n the resource parameter must be identical across all requests. For example,\n Verified Permissions won't evaluate a pair of requests where bob views\n photo1 and alice views photo2. Authorization\n of bob to view photo1 and photo2, or\n bob and alice to view photo1, are valid\n batches.
The request is evaluated against all policies in the specified policy store that match the\n entities that you declare. The result of the decisions is a series of Allow\n or Deny responses, along with the IDs of the policies that produced each\n decision.
The entities of a BatchIsAuthorized API request can contain\n up to 100 principals and up to 100 resources. The requests of a\n BatchIsAuthorized API request can contain up to 30 requests.
The BatchIsAuthorized operation doesn't have its own IAM\n permission. To authorize this operation for Amazon Web Services principals, include the permission\n verifiedpermissions:IsAuthorized in their IAM policies.
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type is used as a field that is part of an Configuration structure that is\n used as a parameter to the Configuration.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type is used as a field that is part of an Configuration structure that is\n used as a parameter to CreateIdentitySource.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.
\nExample: \"userPoolArn\":\n \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n
The unique application client IDs that are associated with the specified Amazon Cognito user\n pool.
\nExample: \"clientIds\": [\"&ExampleCogClientId;\"]\n
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be\n authorized.
Example: \"issuer\":\n \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"\n
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type is used as a field that is part of an ConfigurationDetail structure that is\n part of the response to GetIdentitySource.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.
\nExample: \"userPoolArn\":\n \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n
The unique application client IDs that are associated with the specified Amazon Cognito user\n pool.
\nExample: \"clientIds\": [\"&ExampleCogClientId;\"]\n
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be\n authorized.
Example: \"issuer\":\n \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"\n
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type is used as a field that is part of the ConfigurationItem structure that is\n part of the response to ListIdentitySources.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n
Contains configuration information used when creating a new identity source.
\nAt this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.
\nYou must specify a userPoolArn, and optionally, a\n ClientId.
This data type is used as a request parameter for the CreateIdentitySource\n operation.
" } }, + "com.amazonaws.verifiedpermissions#ConfigurationDetail": { + "type": "union", + "members": { + "cognitoUserPoolConfiguration": { + "target": "com.amazonaws.verifiedpermissions#CognitoUserPoolConfigurationDetail", + "traits": { + "smithy.api#documentation": "Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.
\nExample:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}\n
Contains configuration information about an identity source.
\nThis data type is a response parameter to the GetIdentitySource\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#ConfigurationItem": { + "type": "union", + "members": { + "cognitoUserPoolConfiguration": { + "target": "com.amazonaws.verifiedpermissions#CognitoUserPoolConfigurationItem", + "traits": { + "smithy.api#documentation": "Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.
\nExample:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}\n
Contains configuration information about an identity source.
\nThis data type is a response parameter to the ListIdentitySources\n operation.
" + } + }, "com.amazonaws.verifiedpermissions#ConflictException": { "type": "structure", "members": { @@ -383,8 +471,10 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create a reference to an external identity provider (IdP) that is compatible with OpenID Connect (OIDC) authentication protocol, such as Amazon Cognito", - "smithy.api#documentation": "Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).\n
\nAfter you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken\n operation. These identities take the form of tokens that contain claims about the user,\n such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and\n access tokens, and Verified Permissions can use either or both. Any combination of identity and access\n tokens results in the same Cedar principal. Verified Permissions automatically translates the\n information about the identities into the standard Cedar attributes that can be\n evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain\n different information, the tokens you choose to use determine which principal attributes\n are available to access when evaluating Cedar policies.
\nIf you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
\nTo reference a user from this identity source in your Cedar policies, use the following\n syntax.
\n\n IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>\n
\nWhere IdentityType is the string that you provide to the\n PrincipalEntityType parameter for this operation. The\n CognitoUserPoolId and CognitoClientId are defined by\n the Amazon Cognito user pool.
Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a reference to an Amazon Cognito user pool as an external identity provider (IdP).\n
\nAfter you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken\n operation. These identities take the form of tokens that contain claims about the user,\n such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and\n access tokens, and Verified Permissions can use either or both. Any combination of identity and access\n tokens results in the same Cedar principal. Verified Permissions automatically translates the\n information about the identities into the standard Cedar attributes that can be\n evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain\n different information, the tokens you choose to use determine which principal attributes\n are available to access when evaluating Cedar policies.
\nIf you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
\nTo reference a user from this identity source in your Cedar policies, use the following\n syntax.
\n\n IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>\n
\nWhere IdentityType is the string that you provide to the\n PrincipalEntityType parameter for this operation. The\n CognitoUserPoolId and CognitoClientId are defined by\n the Amazon Cognito user pool.
Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nSpecifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Creates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.
\nTo create a static policy, provide the Cedar policy text in the\n StaticPolicy section of the\n PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID\n and the principal and resource to associate with this policy in the\n templateLinked section of the PolicyDefinition. If the\n policy template is ever updated, any policies linked to the policy template automatically use the\n updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.
\nTo create a static policy, provide the Cedar policy text in the\n StaticPolicy section of the\n PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID\n and the principal and resource to associate with this policy in the\n templateLinked section of the PolicyDefinition. If the\n policy template is ever updated, any policies linked to the policy template automatically use the\n updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nSpecifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Creates a policy store. A policy store is a container for policy resources.
\nAlthough Cedar supports multiple namespaces, Verified Permissions currently supports only one\n namespace per policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a policy store. A policy store is a container for policy resources.
\nAlthough Cedar supports multiple namespaces, Verified Permissions currently supports only one\n namespace per policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nSpecifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Creates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nSpecifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After\n you delete the identity source, you can no longer use tokens for identities from that identity source to\n represent principals in authorization queries made using IsAuthorizedWithToken.\n operations.
", "smithy.api#idempotent": {} } @@ -835,7 +933,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy from the policy store", + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the specified policy from the policy store" + }, "smithy.api#documentation": "Deletes the specified policy from the policy store.
\nThis operation is idempotent; if you specify a policy that doesn't \n exist, the request response returns a successful HTTP 200 status code.
Deletes the specified policy store.
\nThis operation is idempotent. If you specify a policy store that does not exist, the request\n response will still return a successful HTTP 200 status code.
", "smithy.api#idempotent": {} } @@ -922,7 +1024,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy template from the policy store", + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the specified policy template from the policy store" + }, "smithy.api#documentation": "Deletes the specified policy template from the policy store.
\nThis operation also deletes any policies that were created from the specified\n policy template. Those policies are immediately removed from all future API responses, and are\n asynchronously deleted from the policy store.
\nRetrieves the details about the specified identity source.
", "smithy.api#readonly": {} } @@ -1190,8 +1296,10 @@ "details": { "target": "com.amazonaws.verifiedpermissions#IdentitySourceDetails", "traits": { - "smithy.api#documentation": "A structure that describes the configuration of the identity source.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration" + }, + "smithy.api#documentation": "A structure that describes the configuration of the identity source.
" } }, "identitySourceId": { @@ -1222,6 +1330,13 @@ "smithy.api#documentation": "The data type of principals generated for identities authenticated by this\n identity source.
", "smithy.api#required": {} } + }, + "configuration": { + "target": "com.amazonaws.verifiedpermissions#ConfigurationDetail", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "Contains configuration information about an identity source.
" + } } }, "traits": { @@ -1242,7 +1357,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve information about the specified policy", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve information about the specified policy" + }, "smithy.api#documentation": "Retrieves information about the specified policy.
", "smithy.api#readonly": {} } @@ -1348,7 +1465,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve details about a policy store", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve details about a policy store" + }, "smithy.api#documentation": "Retrieves details about a policy store.
", "smithy.api#readonly": {} } @@ -1433,7 +1552,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details for the specified policy template in the specified policy store", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve the details for the specified policy template in the specified policy store" + }, "smithy.api#documentation": "Retrieve the details for the specified policy template in the specified policy store.
", "smithy.api#readonly": {} } @@ -1525,7 +1646,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details for the specified schema in the specified policy store", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve the details for the specified schema in the specified policy store" + }, "smithy.api#documentation": "Retrieve the details for the specified schema in the specified policy store.
", "smithy.api#readonly": {} } @@ -1633,30 +1756,45 @@ "clientIds": { "target": "com.amazonaws.verifiedpermissions#ClientIds", "traits": { + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.clientIds" + }, "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.
" } }, "userPoolArn": { "target": "com.amazonaws.verifiedpermissions#UserPoolArn", "traits": { + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.userPoolArn" + }, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions\n policy store.
" } }, "discoveryUrl": { "target": "com.amazonaws.verifiedpermissions#DiscoveryUrl", "traits": { + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.issuer" + }, "smithy.api#documentation": "The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.
\n\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n
A string that identifies the type of OIDC service represented by this identity source.
\nAt this time, the only valid value is cognito.
A structure that contains configuration of the identity source.
\nThis data type is used as a response parameter for the CreateIdentitySource\n operation.
" + "smithy.api#deprecated": { + "message": "This shape has been replaced by ConfigurationDetail" + }, + "smithy.api#documentation": "A structure that contains configuration of the identity source.
\nThis data type was a response parameter for the GetIdentitySource\n operation. Replaced by ConfigurationDetail.
" } }, "com.amazonaws.verifiedpermissions#IdentitySourceFilter": { @@ -1670,7 +1808,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that defines characteristics of an identity source that you can use to\n filter.
\nThis data type is used as a request parameter for the ListIdentityStores\n operation.
" + "smithy.api#documentation": "A structure that defines characteristics of an identity source that you can use to\n filter.
\nThis data type is a request parameter for the ListIdentityStores\n operation.
" } }, "com.amazonaws.verifiedpermissions#IdentitySourceFilters": { @@ -1708,8 +1846,10 @@ "details": { "target": "com.amazonaws.verifiedpermissions#IdentitySourceItemDetails", "traits": { - "smithy.api#documentation": "A structure that contains the details of the associated identity provider\n (IdP).
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration" + }, + "smithy.api#documentation": "A structure that contains the details of the associated identity provider\n (IdP).
" } }, "identitySourceId": { @@ -1739,10 +1879,16 @@ "smithy.api#documentation": "The Cedar entity type of the principals returned from the IdP associated with this\n identity source.
", "smithy.api#required": {} } + }, + "configuration": { + "target": "com.amazonaws.verifiedpermissions#ConfigurationItem", + "traits": { + "smithy.api#documentation": "Contains configuration information about an identity source.
" + } } }, "traits": { - "smithy.api#documentation": "A structure that defines an identity source.
\nThis data type is used as a request parameter for the ListIdentityStores\n operation.
" + "smithy.api#documentation": "A structure that defines an identity source.
\nThis data type is a response parameter to the ListIdentitySources\n operation.
" } }, "com.amazonaws.verifiedpermissions#IdentitySourceItemDetails": { @@ -1751,30 +1897,45 @@ "clientIds": { "target": "com.amazonaws.verifiedpermissions#ClientIds", "traits": { + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.clientIds" + }, "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.
" } }, "userPoolArn": { "target": "com.amazonaws.verifiedpermissions#UserPoolArn", "traits": { + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.userPoolArn" + }, "smithy.api#documentation": "The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.
" } }, "discoveryUrl": { "target": "com.amazonaws.verifiedpermissions#DiscoveryUrl", "traits": { + "smithy.api#deprecated": { + "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.issuer" + }, "smithy.api#documentation": "The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.
\n\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n
A string that identifies the type of OIDC service represented by this identity source.
\nAt this time, the only valid value is cognito.
A structure that contains configuration of the identity source.
\nThis data type is used as a response parameter for the CreateIdentitySource\n operation.
" + "smithy.api#deprecated": { + "message": "This shape has been replaced by ConfigurationItem" + }, + "smithy.api#documentation": "A structure that contains configuration of the identity source.
\nThis data type was a response parameter for the ListIdentitySources\n operation. Replaced by ConfigurationItem.
" } }, "com.amazonaws.verifiedpermissions#IdentitySources": { @@ -1814,7 +1975,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to make an authorization decision about a service request described in the parameters", + "aws.iam#iamAction": { + "documentation": "Grants permission to make an authorization decision about a service request described in the parameters" + }, "smithy.api#documentation": "Makes an authorization decision about a service request described in the parameters.\n The information in the parameters can also define additional context that Verified Permissions can\n include in the evaluation. The request is evaluated against all matching policies in the\n specified policy store. The result of the decision is either Allow or\n Deny, along with a list of the policies that resulted in the\n decision.
Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source in the form of an identity\n token formatted as a JSON web\n token (JWT). The information in the parameters can also define additional\n context that Verified Permissions can include in the evaluation. The request is evaluated against all\n matching policies in the specified policy store. The result of the decision is either\n Allow or Deny, along with a list of the policies that\n resulted in the decision.
If you specify the identityToken parameter, then this operation\n derives the principal from that token. You must not also include that principal in\n the entities parameter or the operation fails and reports a conflict\n between the two entity sources.
If you provide only an accessToken, then you can include the entity\n as part of the entities parameter to provide additional\n attributes.
At this time, Verified Permissions accepts tokens from only Amazon Cognito.
\nVerified Permissions validates each token that is specified in a request by checking its expiration\n date and its signature.
\nIf you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
\nSpecifies an identity token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an AccessToken or an IdentityToken, or\n both.
Specifies an identity token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an accessToken, an identityToken, or\n both.
Must be an ID token. Verified Permissions returns an error if the token_use claim in the\n submitted token isn't id.
Specifies an access token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an AccessToken, or an IdentityToken, or\n both.
Specifies an access token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an accessToken, an identityToken, or\n both.
Must be an access token. Verified Permissions returns an error if the token_use claim in\n the submitted token isn't access.
Returns a paginated list of all of the identity sources defined in the specified policy store.
", "smithy.api#paginated": { "inputToken": "nextToken", @@ -2094,7 +2271,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policies stored in the specified policy store", + "aws.iam#iamAction": { + "documentation": "Grants permission to return a paginated list of all policies stored in the specified policy store" + }, "smithy.api#documentation": "Returns a paginated list of all policies stored in the specified policy store.
", "smithy.api#paginated": { "inputToken": "nextToken", @@ -2168,7 +2347,9 @@ "target": "com.amazonaws.verifiedpermissions#ListPolicyStoresOutput" }, "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policy stores in the calling Amazon Web Services account", + "aws.iam#iamAction": { + "documentation": "Grants permission to return a paginated list of all policy stores in the calling Amazon Web Services account" + }, "smithy.api#documentation": "Returns a paginated list of all policy stores in the calling Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "nextToken", @@ -2234,7 +2415,9 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policy templates in the specified policy store", + "aws.iam#iamAction": { + "documentation": "Grants permission to return a paginated list of all policy templates in the specified policy store" + }, "smithy.api#documentation": "Returns a paginated list of all policy templates in the specified policy store.
", "smithy.api#paginated": { "inputToken": "nextToken", @@ -2844,8 +3027,10 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create or update the policy schema in the specified policy store", - "smithy.api#documentation": "Creates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nContains information about a policy that was
\n \ncreated by instantiating a policy template.
\nThis
" + "smithy.api#documentation": "Contains information about a policy that was created by instantiating a policy template.
" } }, "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionItem": { @@ -3343,8 +3528,10 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to update the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type", - "smithy.api#documentation": "Updates the specified identity source to use a new identity provider (IdP) source, or to change\n the mapping of identities from the IdP to a different principal entity type.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nUpdates the specified identity source to use a new identity provider (IdP) source, or to change\n the mapping of identities from the IdP to a different principal entity type.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
\nIf policy validation is enabled in the policy store, then updating a static policy causes\n Verified Permissions to validate the policy against the schema in the policy store. If the updated\n static policy doesn't pass validation, the operation fails and the update isn't\n stored.
\nWhen you edit a static policy, You can change only certain elements of a static\n policy:
\nThe action referenced by the policy.
\nA condition clause, such as when and unless.
\nYou can't change these elements of a static policy:
\nChanging a policy from a static policy to a template-linked\n policy.
\nChanging the effect of a static policy from permit or forbid.\n
\nThe principal referenced by a static policy.
\nThe resource referenced by a static policy.
\nTo update a template-linked policy, you must update the template instead.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
\nIf policy validation is enabled in the policy store, then updating a static policy causes\n Verified Permissions to validate the policy against the schema in the policy store. If the updated\n static policy doesn't pass validation, the operation fails and the update isn't\n stored.
\nWhen you edit a static policy, you can change only certain elements of a static\n policy:
\nThe action referenced by the policy.
\nA condition clause, such as when and unless.
\nYou can't change these elements of a static policy:
\nChanging a policy from a static policy to a template-linked\n policy.
\nChanging the effect of a static policy from permit or forbid.\n
\nThe principal referenced by a static policy.
\nThe resource referenced by a static policy.
\nTo update a template-linked policy, you must update the template instead.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies the validation setting for a policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies the validation setting for a policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nUpdates the specified policy template. You can update only the description and the some elements\n of the policyBody.
\nChanges you make to the policy template content are immediately (within the constraints of\n eventual consistency) reflected in authorization decisions that involve all template-linked policies\n instantiated from this template.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nUpdates the specified policy template. You can update only the description and the some elements\n of the policyBody.
\nChanges you make to the policy template content are immediately (within the constraints of\n eventual consistency) reflected in authorization decisions that involve all template-linked policies\n instantiated from this template.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nApplies only to the targeted inspection level.
\nDetermines whether to use machine learning (ML) to\n analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium, which\ninspect for anomalous behavior that might indicate distributed, coordinated bot activity.
For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the\n WAF Developer Guide.
\nDefault: TRUE\n
Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nCustomizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nExample JSON: {\n \"API_GATEWAY\": \"KB_48\",\n \"APP_RUNNER_SERVICE\": \"KB_32\"\n }\n
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" } } }, "traits": { - "smithy.api#documentation": "Specifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nSpecifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" } }, "com.amazonaws.wafv2#BlockAction": { @@ -1834,7 +1858,7 @@ "OversizeHandling": { "target": "com.amazonaws.wafv2#OversizeHandling", "traits": { - "smithy.api#documentation": "What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service \n only forwards the contents that are below the limit to WAF for inspection.
\nThe default limit is 8 KB (8,192 bytes) for regional resources and 16 KB (16,384 bytes) for CloudFront distributions. For CloudFront distributions, \n you can increase the limit in the web ACL AssociationConfig, for additional processing fees.
The options for oversize handling are the following:
\n\n CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE\n
What WAF should do if the body is larger than WAF can inspect.
\nWAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
\nFor CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
The options for oversize handling are the following:
\n\n CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE\n
Specifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nSpecifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" } } }, @@ -5030,6 +5054,9 @@ }, { "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" } ], "traits": { @@ -5307,6 +5334,9 @@ "smithy.api#documentation": "The name of the field in the request payload that contains your customer's email.
\nThis data type is used in the RequestInspectionACFP data type.
Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nA limited amount of the request body is forwarded to WAF for\n inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB (16,384 bytes). For CloudFront distributions,\n you can increase the limit in the web ACL's AssociationConfig, for additional processing fees.
For information about how to handle oversized\n request bodies, see the Body object configuration.
Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nWAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
\nFor CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
For information about how to handle oversized\n request bodies, see the Body object configuration.
Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nA limited amount of the request body is forwarded to WAF for\n inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB (16,384 bytes). For CloudFront distributions,\n you can increase the limit in the web ACL's AssociationConfig, for additional processing fees.
For information about how to handle oversized\n request bodies, see the JsonBody object configuration.
Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.
\nWAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
\nFor CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
For information about how to handle oversized\n request bodies, see the JsonBody object configuration.
The part of the web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.
Example JSON for a QueryString field to match:
\n \"FieldToMatch\": { \"QueryString\": {} }\n
Example JSON for a Method field to match specification:
\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n
Specifies a web request component to be used in a rule match statement or in a logging configuration.
\nIn a rule statement, this is the part of the web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.
Example JSON for a QueryString field to match:
\n \"FieldToMatch\": { \"QueryString\": {} }\n
Example JSON for a Method field to match specification:
\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n
In a logging configuration, this is used in the RedactedFields property to specify a field to \n redact from the logging records. For this use case, note the following:
Even though all FieldToMatch settings \n are available, the only valid settings for field redaction are UriPath, QueryString, SingleHeader, and Method.
In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, \n but for field redaction, you are specifying the component type to redact from the logs.
\nWhat WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service \n only forwards the contents that are below the limit to WAF for inspection.
\nThe default limit is 8 KB (8,192 bytes) for regional resources and 16 KB (16,384 bytes) for CloudFront distributions. For CloudFront distributions, \n you can increase the limit in the web ACL AssociationConfig, for additional processing fees.
The options for oversize handling are the following:
\n\n CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE\n
What WAF should do if the body is larger than WAF can inspect.
\nWAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
\nFor CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
The options for oversize handling are the following:
\n\n CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.
\n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule\n statement.
You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE\n
A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:
\nIP address 10.1.1.1, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nIP address 127.0.0.0, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nThe rule would create different aggregation instances according to your aggregation criteria, for example:
\nIf the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1: count 3
\nIP address 127.0.0.0: count 1
\nIf the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
\nHTTP method POST: count 2
\nHTTP method GET: count 2
\nIf the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1, HTTP method POST: count 1
\nIP address 10.1.1.1, HTTP method GET: count 2
\nIP address 127.0.0.0, HTTP method POST: count 1
\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.
\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
" + "smithy.api#documentation": "A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
\nIf you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:
\nIP address 10.1.1.1, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nIP address 127.0.0.0, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nThe rule would create different aggregation instances according to your aggregation criteria, for example:
\nIf the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1: count 3
\nIP address 127.0.0.0: count 1
\nIf the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
\nHTTP method POST: count 2
\nHTTP method GET: count 2
\nIf the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1, HTTP method POST: count 1
\nIP address 10.1.1.1, HTTP method GET: count 2
\nIP address 127.0.0.0, HTTP method POST: count 1
\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.
\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
" } }, "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType": { @@ -9823,7 +9856,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 5 } } @@ -10225,13 +10258,13 @@ "DefaultSizeInspectionLimit": { "target": "com.amazonaws.wafv2#SizeInspectionLimit", "traits": { - "smithy.api#documentation": "Specifies the maximum size of the web request body component that an associated CloudFront distribution should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
\nDefault: 16 KB (16,384 bytes)\n
Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
\nDefault: 16 KB (16,384 bytes)\n
Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nThis is used in the AssociationConfig of the web ACL.
Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nExample JSON: {\n \"API_GATEWAY\": \"KB_48\",\n \"APP_RUNNER_SERVICE\": \"KB_32\"\n }\n
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
\nThis is used in the AssociationConfig of the web ACL.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 bytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 bytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 bytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 bytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
\nIf you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:
\nIP address 10.1.1.1, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nIP address 127.0.0.0, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nThe rule would create different aggregation instances according to your aggregation criteria, for example:
\nIf the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1: count 3
\nIP address 127.0.0.0: count 1
\nIf the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
\nHTTP method POST: count 2
\nHTTP method GET: count 2
\nIf the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1, HTTP method POST: count 1
\nIP address 10.1.1.1, HTTP method GET: count 2
\nIP address 127.0.0.0, HTTP method POST: count 1
\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.
\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
" + "smithy.api#documentation": "A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
\nIf you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:
\nIP address 10.1.1.1, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nIP address 127.0.0.0, HTTP method POST
\nIP address 10.1.1.1, HTTP method GET
\nThe rule would create different aggregation instances according to your aggregation criteria, for example:
\nIf the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1: count 3
\nIP address 127.0.0.0: count 1
\nIf the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
\nHTTP method POST: count 2
\nHTTP method GET: count 2
\nIf the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
\nIP address 10.1.1.1, HTTP method POST: count 1
\nIP address 10.1.1.1, HTTP method GET: count 2
\nIP address 127.0.0.0, HTTP method POST: count 1
\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
\nYou cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.
\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
" } }, "AndStatement": { @@ -12381,7 +12417,7 @@ "AssociationConfig": { "target": "com.amazonaws.wafv2#AssociationConfig", "traits": { - "smithy.api#documentation": "Specifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nSpecifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" } } }, @@ -12636,6 +12672,12 @@ "members": { "Message": { "target": "com.amazonaws.wafv2#ErrorMessage" + }, + "SourceType": { + "target": "com.amazonaws.wafv2#SourceType", + "traits": { + "smithy.api#documentation": "Source type for the exception.
" + } } }, "traits": { @@ -12860,7 +12902,7 @@ "AssociationConfig": { "target": "com.amazonaws.wafv2#AssociationConfig", "traits": { - "smithy.api#documentation": "Specifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nSpecifies custom configurations for the associations between the web ACL and protected resources.
\nUse this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
\nFor Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" } } }, diff --git a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json index 78d911dc5db..74b4d588336 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json +++ b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json @@ -2089,7 +2089,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates one or more WorkSpaces.
\nThis operation is asynchronous and returns before the WorkSpaces are created.
\nThe MANUAL running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.
You don't need to specify the PCOIP protocol for Linux bundles\n because WSP is the default protocol for those bundles.
Creates one or more WorkSpaces.
\nThis operation is asynchronous and returns before the WorkSpaces are created.
\nThe MANUAL running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.
You don't need to specify the PCOIP protocol for Linux bundles\n because WSP is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n Core.
\nReboots the specified WorkSpaces.
\nYou cannot reboot a WorkSpace unless its state is AVAILABLE or\n UNHEALTHY.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
" + "smithy.api#documentation": "Reboots the specified WorkSpaces.
\nYou cannot reboot a WorkSpace unless its state is AVAILABLE,\n UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING \n state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
" } }, "com.amazonaws.workspaces#RebootWorkspacesRequest": { @@ -7915,7 +7915,7 @@ "State": { "target": "com.amazonaws.workspaces#WorkspaceState", "traits": { - "smithy.api#documentation": "The operational state of the WorkSpace.
\nAfter a WorkSpace is terminated, the TERMINATED state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.
The operational state of the WorkSpace.
\n\n PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
\n AVAILABLE – The WorkSpace is running and has passed the health checks.
\n IMPAIRED – Refer to UNHEALTHY state.
\n UNHEALTHY – The WorkSpace is not responding to health checks.
\n REBOOTING – The WorkSpace is being rebooted (restarted).
\n STARTING – The WorkSpace is starting up and health checks are being run.
\n REBUILDING – The WorkSpace is being rebuilt.
\n RESTORING – The WorkSpace is being restored.
\n MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
\n ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
\n TERMINATING – The WorkSpace is being deleted.
\n TERMINATED – The WorkSpace has been deleted.
\n SUSPENDED – The WorkSpace has been suspended for image creation.
\n UPDATING – The WorkSpace is undergoing an update.
\n STOPPING – The WorkSpace is being stopped.
\n STOPPED – The WorkSpace has been stopped.
\n ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
After a WorkSpace is terminated, the TERMINATED state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.