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/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 4c7fd781485..fa802c2bbb2 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -9215,7 +9215,7 @@ "target": "com.amazonaws.ec2#BundleInstanceResult" }, "traits": { - "smithy.api#documentation": "Bundles 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.
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 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 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": { @@ -55425,7 +55432,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "IsPublic", - "smithy.api#documentation": "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.
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.
" } } }, @@ -71431,7 +71438,7 @@ "target": "com.amazonaws.ec2#ListImagesInRecycleBinResult" }, "traits": { - "smithy.api#documentation": "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.
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": { diff --git a/codegen/sdk-codegen/aws-models/grafana.json b/codegen/sdk-codegen/aws-models/grafana.json index df39cab2155..f95fbc801cf 100644 --- a/codegen/sdk-codegen/aws-models/grafana.json +++ b/codegen/sdk-codegen/aws-models/grafana.json @@ -113,7 +113,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -156,7 +155,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -169,7 +169,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -183,7 +182,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -206,7 +204,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -241,7 +238,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -252,14 +248,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -273,14 +271,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -289,11 +285,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -304,14 +300,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -325,7 +323,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -345,7 +342,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -356,14 +352,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -374,9 +372,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1003,10 +1003,17 @@ "licenseType": { "target": "com.amazonaws.grafana#LicenseType", "traits": { - "smithy.api#documentation": "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/lambda.json b/codegen/sdk-codegen/aws-models/lambda.json index ba2cafd1339..90ab1cd3fbd 100644 --- a/codegen/sdk-codegen/aws-models/lambda.json +++ b/codegen/sdk-codegen/aws-models/lambda.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/payment-cryptography-data.json b/codegen/sdk-codegen/aws-models/payment-cryptography-data.json index 86ed0c3fc80..b4d185a3ffa 100644 --- a/codegen/sdk-codegen/aws-models/payment-cryptography-data.json +++ b/codegen/sdk-codegen/aws-models/payment-cryptography-data.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": { @@ -1899,7 +1982,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1918,7 +2000,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -1946,13 +2027,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -1965,7 +2047,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1979,7 +2060,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2002,7 +2082,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2037,11 +2116,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -2052,16 +2129,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2075,14 +2155,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -2091,15 +2169,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -2110,16 +2187,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2133,7 +2213,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2153,11 +2232,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -2168,20 +2245,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -2192,18 +2271,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -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/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 77e75557bb9..2b818b87e41 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -4394,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.
The CA certificate identifier to use for the DB cluster's server certificate.
\nValid for Cluster Type: Multi-AZ DB clusters
" + "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
" } } }, @@ -21570,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
The CA certificate identifier to use for the DB cluster's server certificate.
\nValid for Cluster Type: Multi-AZ DB clusters
" + "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
" } } }, @@ -22111,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 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.
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.
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/wafv2.json b/codegen/sdk-codegen/aws-models/wafv2.json index af2b2435a31..0b3edf24788 100644 --- a/codegen/sdk-codegen/aws-models/wafv2.json +++ b/codegen/sdk-codegen/aws-models/wafv2.json @@ -185,9 +185,9 @@ } }, "EnableMachineLearning": { - "target": "com.amazonaws.wafv2#Boolean", + "target": "com.amazonaws.wafv2#EnableMachineLearning", "traits": { - "smithy.api#default": false, + "smithy.api#default": true, "smithy.api#documentation": "Applies 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.json b/codegen/sdk-codegen/aws-models/workspaces.json index 78d911dc5db..74b4d588336 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.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.