From 4c2c4bde6821de10fa9716275fc667872b2308b0 Mon Sep 17 00:00:00 2001 From: Aaron J Todd Date: Thu, 21 Apr 2022 14:20:12 -0400 Subject: [PATCH] chore: sync AWS models --- codegen/sdk/aws-models/appflow.json | 100 +- codegen/sdk/aws-models/appstream.json | 22 + codegen/sdk/aws-models/athena.json | 34 +- codegen/sdk/aws-models/auto-scaling.json | 143 +- codegen/sdk/aws-models/batch.json | 255 +++- codegen/sdk/aws-models/cloudwatch.json | 39 +- codegen/sdk/aws-models/connect.json | 1025 ++++++++++++++- codegen/sdk/aws-models/ec2.json | 212 ++- codegen/sdk/aws-models/elasticache.json | 27 +- codegen/sdk/aws-models/glue.json | 318 +++++ codegen/sdk/aws-models/iotsitewise.json | 1314 ++++++++++++++++--- codegen/sdk/aws-models/iottwinmaker.json | 23 +- codegen/sdk/aws-models/kendra.json | 167 ++- codegen/sdk/aws-models/kms.json | 533 ++++++-- codegen/sdk/aws-models/lightsail.json | 94 +- codegen/sdk/aws-models/lookoutmetrics.json | 355 +++++ codegen/sdk/aws-models/macie2.json | 33 +- codegen/sdk/aws-models/mediatailor.json | 609 ++++++++- codegen/sdk/aws-models/mgn.json | 407 +++--- codegen/sdk/aws-models/personalize.json | 129 +- codegen/sdk/aws-models/polly.json | 8 + codegen/sdk/aws-models/rds.json | 684 ++-------- codegen/sdk/aws-models/redshift.json | 94 +- codegen/sdk/aws-models/secrets-manager.json | 80 +- codegen/sdk/aws-models/ssm.json | 59 +- codegen/sdk/aws-models/storage-gateway.json | 44 +- codegen/sdk/aws-models/textract.json | 129 +- codegen/sdk/aws-models/transfer.json | 43 +- codegen/sdk/aws-models/wisdom.json | 393 ++++-- codegen/sdk/aws-models/worklink.json | 139 +- 30 files changed, 6011 insertions(+), 1501 deletions(-) diff --git a/codegen/sdk/aws-models/appflow.json b/codegen/sdk/aws-models/appflow.json index 1ea5b90c8d4..f21f240a81f 100644 --- a/codegen/sdk/aws-models/appflow.json +++ b/codegen/sdk/aws-models/appflow.json @@ -283,7 +283,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 2048 }, "smithy.api#pattern": "^\\S+$" } @@ -4871,6 +4871,77 @@ "smithy.api#documentation": "

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

" } }, + "com.amazonaws.appflow#OAuth2CustomParameter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.appflow#Key", + "traits": { + "smithy.api#documentation": "

The key of the custom parameter required for OAuth 2.0 authentication.

" + } + }, + "isRequired": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the custom parameter for OAuth 2.0 authentication is required.

" + } + }, + "label": { + "target": "com.amazonaws.appflow#Label", + "traits": { + "smithy.api#documentation": "

The label of the custom parameter used for OAuth 2.0 authentication.

" + } + }, + "description": { + "target": "com.amazonaws.appflow#Description", + "traits": { + "smithy.api#documentation": "

A description about the custom parameter used for OAuth 2.0 authentication.

" + } + }, + "isSensitiveField": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this authentication custom parameter is a sensitive field.

" + } + }, + "connectorSuppliedValues": { + "target": "com.amazonaws.appflow#ConnectorSuppliedValueList", + "traits": { + "smithy.api#documentation": "

Contains default values for this authentication parameter that are supplied by the\n connector.

" + } + }, + "type": { + "target": "com.amazonaws.appflow#OAuth2CustomPropType", + "traits": { + "smithy.api#documentation": "

Indicates whether custom parameter is used with TokenUrl or AuthUrl.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom parameter required for OAuth 2.0 authentication.

" + } + }, + "com.amazonaws.appflow#OAuth2CustomPropType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TOKEN_URL", + "name": "TOKEN_URL" + }, + { + "value": "AUTH_URL", + "name": "AUTH_URL" + } + ] + } + }, + "com.amazonaws.appflow#OAuth2CustomPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#OAuth2CustomParameter" + } + }, "com.amazonaws.appflow#OAuth2Defaults": { "type": "structure", "members": { @@ -4897,6 +4968,12 @@ "traits": { "smithy.api#documentation": "

OAuth 2.0 grant types supported by the connector.

" } + }, + "oauth2CustomProperties": { + "target": "com.amazonaws.appflow#OAuth2CustomPropertiesList", + "traits": { + "smithy.api#documentation": "

List of custom parameters required for OAuth 2.0 authentication.

" + } } }, "traits": { @@ -4940,6 +5017,12 @@ "smithy.api#documentation": "

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

", "smithy.api#required": {} } + }, + "tokenUrlCustomProperties": { + "target": "com.amazonaws.appflow#TokenUrlCustomProperties", + "traits": { + "smithy.api#documentation": "

Associates your token URL with a map of properties that you define. Use this parameter\n to provide any additional details that the connector requires to authenticate your\n request.

" + } } }, "traits": { @@ -7799,6 +7882,21 @@ "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" } }, + "com.amazonaws.appflow#TokenUrlCustomProperties": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#CustomPropertyKey" + }, + "value": { + "target": "com.amazonaws.appflow#CustomPropertyValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.appflow#TokenUrlList": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/appstream.json b/codegen/sdk/aws-models/appstream.json index 667c0ca134b..a3bdb0f1389 100644 --- a/codegen/sdk/aws-models/appstream.json +++ b/codegen/sdk/aws-models/appstream.json @@ -1382,6 +1382,12 @@ "traits": { "smithy.api#documentation": "

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

" } + }, + "SessionScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" + } } } }, @@ -4121,6 +4127,12 @@ "traits": { "smithy.api#documentation": "

The USB device filter strings associated with the fleet.

" } + }, + "SessionScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" + } } }, "traits": { @@ -4151,6 +4163,10 @@ { "value": "USB_DEVICE_FILTER_STRINGS", "name": "USB_DEVICE_FILTER_STRINGS" + }, + { + "value": "SESSION_SCRIPT_S3_LOCATION", + "name": "SESSION_SCRIPT_S3_LOCATION" } ] } @@ -6867,6 +6883,12 @@ "traits": { "smithy.api#documentation": "

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

" } + }, + "SessionScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" + } } } }, diff --git a/codegen/sdk/aws-models/athena.json b/codegen/sdk/aws-models/athena.json index 5a24124b64b..a5807d38977 100644 --- a/codegen/sdk/aws-models/athena.json +++ b/codegen/sdk/aws-models/athena.json @@ -35,7 +35,7 @@ "S3AclOption": { "target": "com.amazonaws.athena#S3AclOption", "traits": { - "smithy.api#documentation": "

The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the\n workgroup overrides client-side settings, then the Amazon S3 canned ACL\n specified in the workgroup's settings is used for all queries that run in the workgroup.\n For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User\n Guide.

", + "smithy.api#documentation": "

The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the\n workgroup overrides client-side settings, then the Amazon S3 canned ACL\n specified in the workgroup's settings is used for all queries that run in the workgroup.\n For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

", "smithy.api#required": {} } } @@ -193,6 +193,18 @@ "traits": { "smithy.api#documentation": "

An integer value that provides specific information about an Athena query\n error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User\n Guide.

" } + }, + "Retryable": { + "target": "com.amazonaws.athena#Boolean", + "traits": { + "smithy.api#documentation": "

True if the query might succeed if resubmitted.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.athena#String", + "traits": { + "smithy.api#documentation": "

Contains a short description of the error that occurred.

" + } } }, "traits": { @@ -1027,19 +1039,19 @@ "EncryptionOption": { "target": "com.amazonaws.athena#EncryptionOption", "traits": { - "smithy.api#documentation": "

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys\n (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is\n used.

\n

If a query runs in a workgroup and the workgroup overrides client-side settings, then\n the workgroup's setting for encryption is used. It specifies whether query results must\n be encrypted, for all queries that run in this workgroup.

", + "smithy.api#documentation": "

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys\n (SSE_KMS), or client-side encryption with KMS-managed keys\n (CSE_KMS) is used.

\n

If a query runs in a workgroup and the workgroup overrides client-side settings, then\n the workgroup's setting for encryption is used. It specifies whether query results must\n be encrypted, for all queries that run in this workgroup.

", "smithy.api#required": {} } }, "KmsKey": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

For SSE-KMS and CSE-KMS, this is the KMS key ARN or\n ID.

" + "smithy.api#documentation": "

For SSE_KMS and CSE_KMS, this is the KMS key ARN or\n ID.

" } } }, "traits": { - "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE-KMS or CSE-KMS) and key\n information.

" + "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE_KMS or CSE_KMS) and key\n information.

" } }, "com.amazonaws.athena#EncryptionOption": { @@ -2356,7 +2368,7 @@ } }, "traits": { - "smithy.api#documentation": "

A query, where QueryString contains the SQL statements that\n make up the query.

" + "smithy.api#documentation": "

A query, where QueryString contains the SQL statements that make up the\n query.

" } }, "com.amazonaws.athena#NamedQueryDescriptionString": { @@ -2731,13 +2743,13 @@ "EncryptionConfiguration": { "target": "com.amazonaws.athena#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE-KMS or CSE-KMS) and key information.\n This is a client-side setting. If workgroup settings override client-side settings, then\n the query uses the encryption configuration that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE_KMS or CSE_KMS) and key information.\n This is a client-side setting. If workgroup settings override client-side settings, then\n the query uses the encryption configuration that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" } }, "ExpectedBucketOwner": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.

\n

This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the ExpectedBucketOwner setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration\n and Workgroup Settings Override Client-Side Settings.

" + "smithy.api#documentation": "

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.

\n

This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the ExpectedBucketOwner setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration\n and Workgroup Settings Override Client-Side Settings.

" } }, "AclConfiguration": { @@ -2763,7 +2775,7 @@ "RemoveOutputLocation": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the\n OutputLocation in ResultConfigurationUpdates (the\n client-side setting), the OutputLocation in the workgroup's\n ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

" + "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the\n OutputLocation in ResultConfigurationUpdates (the\n client-side setting), the OutputLocation in the workgroup's\n ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

" } }, "EncryptionConfiguration": { @@ -2781,13 +2793,13 @@ "ExpectedBucketOwner": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.

\n \n

If workgroup settings override client-side settings, then the query uses the\n ExpectedBucketOwner setting that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + "smithy.api#documentation": "

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.

\n\n

If workgroup settings override client-side settings, then the query uses the\n ExpectedBucketOwner setting that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" } }, "RemoveExpectedBucketOwner": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If set to \"true\", removes the Amazon Web Services account ID previously specified for\n ResultConfiguration$ExpectedBucketOwner. If set to \"false\" or not\n set, and a value is present in the ExpectedBucketOwner in\n ResultConfigurationUpdates (the client-side setting), the\n ExpectedBucketOwner in the workgroup's ResultConfiguration\n is updated with the new value. For more information, see Workgroup Settings Override\n Client-Side Settings.

" + "smithy.api#documentation": "

If set to \"true\", removes the Amazon Web Services account ID previously specified for\n ResultConfiguration$ExpectedBucketOwner. If set to \"false\" or not\n set, and a value is present in the ExpectedBucketOwner in\n ResultConfigurationUpdates (the client-side setting), the\n ExpectedBucketOwner in the workgroup's ResultConfiguration\n is updated with the new value. For more information, see Workgroup Settings Override\n Client-Side Settings.

" } }, "AclConfiguration": { @@ -3407,7 +3419,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a NamedQuery object. The database or workgroup cannot be updated.

", + "smithy.api#documentation": "

Updates a NamedQuery object. The database or workgroup cannot be\n updated.

", "smithy.api#idempotent": {} } }, diff --git a/codegen/sdk/aws-models/auto-scaling.json b/codegen/sdk/aws-models/auto-scaling.json index 6fb25d9b68d..2d80fed1b25 100644 --- a/codegen/sdk/aws-models/auto-scaling.json +++ b/codegen/sdk/aws-models/auto-scaling.json @@ -394,6 +394,9 @@ "input": { "target": "com.amazonaws.autoscaling#AttachInstancesQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -607,7 +610,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check.

" + "smithy.api#documentation": "

The duration of the health check grace period, in seconds.

" } }, "Instances": { @@ -710,7 +713,13 @@ "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

" + "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only.

" + } + }, + "DefaultInstanceWarmup": { + "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", + "traits": { + "smithy.api#documentation": "

The duration of the default instance warmup, in seconds.

" } } }, @@ -1568,6 +1577,9 @@ "input": { "target": "com.amazonaws.autoscaling#CreateAutoScalingGroupType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -1643,7 +1655,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling\n in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: 300 seconds

" } }, "AvailabilityZones": { @@ -1673,13 +1685,13 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

\n \n

\n

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Default: 0 seconds

" } }, "PlacementGroup": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of an existing placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " } }, "VPCZoneIdentifier": { @@ -1741,6 +1753,12 @@ "traits": { "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n \n

Valid values: units | vcpu | memory-mib\n

" } + }, + "DefaultInstanceWarmup": { + "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, until a newly launched instance can contribute to the\n Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling\n aggregates instance metrics, resulting in more reliable usage data. Set this value equal\n to the amount of time that it takes for resource consumption to become stable after an\n instance reaches the InService state. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, even if its value is set to 0 seconds.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies.

\n

If you need to remove a value that you previously set, include the property but\n specify -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n 0.

\n \n

Default: None

" + } } } }, @@ -1749,6 +1767,9 @@ "input": { "target": "com.amazonaws.autoscaling#CreateLaunchConfigurationType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -1795,13 +1816,13 @@ "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

This parameter can only be used if you are launching EC2-Classic instances.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances.

" } }, "ClassicLinkVPCSecurityGroups": { "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify the ClassicLinkVPCId parameter, you must specify this\n parameter.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you specify the ClassicLinkVPCId parameter, you must specify this\n parameter.

" } }, "UserData": { @@ -1889,6 +1910,9 @@ "input": { "target": "com.amazonaws.autoscaling#CreateOrUpdateTagsType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -1960,11 +1984,20 @@ "smithy.api#documentation": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.

\n

To create your customized metric specification:

\n \n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.

\n \n

Each individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n " } }, + "com.amazonaws.autoscaling#DefaultInstanceWarmup": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.autoscaling#DeleteAutoScalingGroup": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeleteAutoScalingGroupType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2003,6 +2036,9 @@ "input": { "target": "com.amazonaws.autoscaling#LaunchConfigurationNameType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2060,6 +2096,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeleteNotificationConfigurationType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2093,6 +2132,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeletePolicyType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2128,6 +2170,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeleteScheduledActionType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2161,6 +2206,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeleteTagsType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2235,6 +2283,9 @@ }, "com.amazonaws.autoscaling#DescribeAccountLimits": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer" }, @@ -2278,6 +2329,9 @@ }, "com.amazonaws.autoscaling#DescribeAdjustmentTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer" }, @@ -2455,6 +2509,9 @@ }, "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer" }, @@ -2573,6 +2630,9 @@ }, "com.amazonaws.autoscaling#DescribeLifecycleHookTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer" }, @@ -2766,6 +2826,9 @@ }, "com.amazonaws.autoscaling#DescribeMetricCollectionTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer" }, @@ -2989,6 +3052,9 @@ }, "com.amazonaws.autoscaling#DescribeScalingProcessTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#ProcessesType" }, @@ -3119,6 +3185,9 @@ }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer" }, @@ -3364,6 +3433,9 @@ "input": { "target": "com.amazonaws.autoscaling#DisableMetricsCollectionQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -3458,6 +3530,9 @@ "input": { "target": "com.amazonaws.autoscaling#EnableMetricsCollectionQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -3604,6 +3679,9 @@ "input": { "target": "com.amazonaws.autoscaling#ExecutePolicyType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -3737,7 +3815,7 @@ "Name": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

\n " + "smithy.api#documentation": "

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

\n " } }, "Values": { @@ -4517,13 +4595,13 @@ "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

" } }, "ClassicLinkVPCSecurityGroups": { "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.

\n

For more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.

" } }, "UserData": { @@ -4824,7 +4902,7 @@ "GlobalTimeout": { "target": "com.amazonaws.autoscaling#GlobalTimeout", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that an instance can remain in a\n Pending:Wait or Terminating:Wait state. The maximum is\n 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.

" + "smithy.api#documentation": "

The maximum time, in seconds, that an instance can remain in a wait state. The maximum\n is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.

" } }, "DefaultResult": { @@ -5776,7 +5854,7 @@ "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#MetricType", "traits": { - "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

\n ", + "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

\n ", "smithy.api#required": {} } }, @@ -6216,6 +6294,9 @@ "input": { "target": "com.amazonaws.autoscaling#PutNotificationConfigurationType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#LimitExceededFault" @@ -6330,7 +6411,7 @@ "Cooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds. When a cooldown period is\n specified here, it overrides the default cooldown period defined for the Auto Scaling\n group.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: None

" } }, "MetricAggregationType": { @@ -6348,7 +6429,7 @@ "EstimatedInstanceWarmup": { "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", "traits": { - "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. If not provided, the default is to use the value from the default cooldown\n period for the Auto Scaling group.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

" + "smithy.api#documentation": "

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This warm-up period applies to instances launched due to a specific target\n tracking or step scaling policy. When a warm-up period is specified here, it overrides\n the default instance warmup.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then EstimatedInstanceWarmup\n falls back to the value of default cooldown.

\n " } }, "TargetTrackingConfiguration": { @@ -6376,6 +6457,9 @@ "input": { "target": "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -6585,13 +6669,13 @@ "MinHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { - "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must remain healthy during an instance\n refresh to allow the operation to continue. The value is expressed as a percentage of\n the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default\n is 90.

\n

Setting the minimum healthy percentage to 100 percent limits the rate of replacement\n to one instance at a time. In contrast, setting it to 0 percent has the effect of\n replacing all instances at the same time.

" + "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must pass your group's health checks to\n allow the operation to continue. The value is expressed as a percentage of the desired\n capacity of the Auto Scaling group (rounded up to the nearest integer). The default is\n 90.

\n

Setting the minimum healthy percentage to 100 percent limits the rate of replacement\n to one instance at a time. In contrast, setting it to 0 percent has the effect of\n replacing all instances at the same time.

" } }, "InstanceWarmup": { "target": "com.amazonaws.autoscaling#RefreshInstanceWarmup", "traits": { - "smithy.api#documentation": "

The number of seconds until a newly launched instance is configured and ready to use.\n During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The\n default is to use the value for the health check grace period defined for the\n group.

" + "smithy.api#documentation": "

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The duration of the instance warmup, in seconds.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then InstanceWarmup falls\n back to the value of the health check grace period.

\n " } }, "CheckpointPercentages": { @@ -6683,6 +6767,9 @@ "input": { "target": "com.amazonaws.autoscaling#ScalingProcessQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7110,6 +7197,9 @@ "input": { "target": "com.amazonaws.autoscaling#SetDesiredCapacityType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7152,6 +7242,9 @@ "input": { "target": "com.amazonaws.autoscaling#SetInstanceHealthQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7371,6 +7464,9 @@ "input": { "target": "com.amazonaws.autoscaling#ScalingProcessQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7647,6 +7743,9 @@ "input": { "target": "com.amazonaws.autoscaling#UpdateAutoScalingGroupType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7711,7 +7810,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling\n in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, "AvailabilityZones": { @@ -7729,13 +7828,13 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

" } }, "PlacementGroup": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of an existing placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " } }, "VPCZoneIdentifier": { @@ -7785,6 +7884,12 @@ "traits": { "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

" } + }, + "DefaultInstanceWarmup": { + "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, until a newly launched instance can contribute to the\n Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling\n aggregates instance metrics, resulting in more reliable usage data. Set this value equal\n to the amount of time that it takes for resource consumption to become stable after an\n instance reaches the InService state. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, even if its value is set to 0 seconds.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies.

\n

If you need to remove a value that you previously set, include the property but\n specify -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n 0.

\n " + } } } }, diff --git a/codegen/sdk/aws-models/batch.json b/codegen/sdk/aws-models/batch.json index 4e5af544be5..50f9f9c1e7f 100644 --- a/codegen/sdk/aws-models/batch.json +++ b/codegen/sdk/aws-models/batch.json @@ -415,6 +415,21 @@ ] } }, + "com.amazonaws.batch#CRUpdateAllocationStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BEST_FIT_PROGRESSIVE", + "name": "BEST_FIT_PROGRESSIVE" + }, + { + "value": "SPOT_CAPACITY_OPTIMIZED", + "name": "SPOT_CAPACITY_OPTIMIZED" + } + ] + } + }, "com.amazonaws.batch#CancelJob": { "type": "operation", "input": { @@ -505,8 +520,7 @@ "ecsClusterArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

" } }, "tags": { @@ -518,7 +532,7 @@ "type": { "target": "com.amazonaws.batch#CEType", "traits": { - "smithy.api#documentation": "

The type of the compute environment: MANAGED or UNMANAGED. For more information, see\n Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

The type of the compute environment: MANAGED or UNMANAGED. For more information, see\n Compute environments in the\n Batch User Guide.

" } }, "state": { @@ -542,7 +556,7 @@ "computeResources": { "target": "com.amazonaws.batch#ComputeResource", "traits": { - "smithy.api#documentation": "

The compute resources defined for the compute environment. For more information, see Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

The compute resources defined for the compute environment. For more information, see Compute environments in the\n Batch User Guide.

" } }, "serviceRole": { @@ -550,6 +564,12 @@ "traits": { "smithy.api#documentation": "

The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API\n operations on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.

" } + }, + "updatePolicy": { + "target": "com.amazonaws.batch#UpdatePolicy", + "traits": { + "smithy.api#documentation": "

Specifies the infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Updating compute\n environments in the Batch User Guide.

" + } } }, "traits": { @@ -596,20 +616,20 @@ "type": { "target": "com.amazonaws.batch#CRType", "traits": { - "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute Environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the\n Batch User Guide.

", + "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.

", "smithy.api#required": {} } }, "allocationStrategy": { "target": "com.amazonaws.batch#CRAllocationStrategy", "traits": { - "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance\n type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation Strategies\n in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n
\n
BEST_FIT (default)
\n
\n

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost\n instance type. If additional instances of the selected instance type aren't available, Batch waits for the\n additional instances to be available. If there aren't enough instances available, or if the user is reaching\n Amazon EC2 service limits\n then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps\n costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM\n Role must be specified.

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch will select additional instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the\n previously selected instance types aren't available, Batch will select new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy\n is only available for Spot Instance compute resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might\n need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

" + "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance\n type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies\n in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n
\n
BEST_FIT (default)
\n
\n

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost\n instance type. If additional instances of the selected instance type aren't available, Batch waits for the\n additional instances to be available. If there aren't enough instances available, or if the user is reaching\n Amazon EC2 service limits\n then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps\n costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM\n Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support\n infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the\n Batch User Guide.

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch will select additional instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the\n previously selected instance types aren't available, Batch will select new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy\n is only available for Spot Instance compute resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might\n need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

" } }, "minvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "maxvCpus": { @@ -622,13 +642,13 @@ "desiredvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values, based on job queue demand.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values, based on job queue demand.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n \n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are\n used.

\n " + "smithy.api#documentation": "

The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n \n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are\n used.

\n " } }, "imageId": { @@ -637,13 +657,13 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use ec2Configuration[].imageIdOverride instead." }, - "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

\n " + "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

\n " } }, "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User\n Guide.

", + "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User\n Guide.

", "smithy.api#required": {} } }, @@ -656,54 +676,54 @@ "ec2KeyPair": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "instanceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS Instance\n Role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS instance\n role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "tags": { "target": "com.amazonaws.batch#TagsMap", "traits": { - "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any\n changes to these tags require that you create a new compute environment and remove the old compute environment. These\n tags aren't seen when using the Batch ListTagsForResource API operation.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any\n changes to these tags require that you create a new compute environment and remove the old compute environment. These\n tags aren't seen when using the Batch ListTagsForResource API operation.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "placementGroup": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for\n Linux Instances.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for\n Linux Instances.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "bidPercentage": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "spotIamFleetRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is\n required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For\n more information, see Amazon EC2 Spot Fleet\n Role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot\n Instances. For more information, see Spot Instances not tagged on creation in the\n Batch User Guide.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is\n required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For\n more information, see Amazon EC2 spot fleet\n role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot\n Instances. For more information, see Spot instances not tagged on creation in the\n Batch User Guide.

\n " } }, "launchTemplate": { "target": "com.amazonaws.batch#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The launch template to use for your compute resources. Any other compute resource parameters that you specify in\n a CreateComputeEnvironment API operation override the same parameters in the launch template. You\n must specify either the launch template ID or launch template name in the request, but not both. For more\n information, see Launch Template Support in\n the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The launch template to use for your compute resources. Any other compute resource parameters that you specify in\n a CreateComputeEnvironment API operation override the same parameters in the launch template. You\n must specify either the launch template ID or launch template name in the request, but not both. For more\n information, see Launch template support in\n the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "ec2Configuration": { "target": "com.amazonaws.batch#Ec2ConfigurationList", "traits": { - "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.

\n

One or two values can be provided.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.

\n

One or two values can be provided.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } } }, "traits": { - "smithy.api#documentation": "

An object representing an Batch compute resource. For more information, see Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

An object representing an Batch compute resource. For more information, see Compute environments in the\n Batch User Guide.

" } }, "com.amazonaws.batch#ComputeResourceUpdate": { @@ -712,7 +732,7 @@ "minvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "maxvCpus": { @@ -724,24 +744,96 @@ "desiredvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values based on job queue demand.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16\n subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This\n can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User\n Guide.

" + "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16\n subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't\n specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the\n compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.

\n

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

" } }, "securityGroupIds": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is\n required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for\n EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is\n made.

" + "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is\n required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute\n resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2\n compute resources, providing an empty list removes the security groups from the compute resource.

\n

When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

" + } + }, + "allocationStrategy": { + "target": "com.amazonaws.batch#CRUpdateAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance\n type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies\n in the Batch User Guide.

\n

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide. BEST_FIT isn't supported when updating a compute\n environment.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch will select additional instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the\n previously selected instance types aren't available, Batch will select new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy\n is only available for Spot Instance compute resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might\n need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

" + } + }, + "instanceTypes": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "

The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n \n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are\n used.

\n " + } + }, + "ec2KeyPair": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

\n

When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "instanceRole": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS instance\n role in the Batch User Guide.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "tags": { + "target": "com.amazonaws.batch#TagsMap", + "traits": { + "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags aren't seen when using the Batch ListTagsForResource API\n operation.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "placementGroup": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for\n Linux Instances.

\n

When updating a compute environment, changing the placement group requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "bidPercentage": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage.

\n

When updating a compute environment, changing the bid percentage requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "launchTemplate": { + "target": "com.amazonaws.batch#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The updated launch template to use for your compute resources. You must specify either the launch template ID or\n launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.\n To remove the custom launch template and use the default launch template, set launchTemplateId or\n launchTemplateName member of the launch template specification to an empty string. Removing the launch\n template from a compute environment will not remove the AMI specified in the launch template. In order to update the\n AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to\n true.

\n

When updating a compute environment, changing the launch template requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "ec2Configuration": { + "target": "com.amazonaws.batch#Ec2ConfigurationList", + "traits": { + "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration\n and any custom AMI ID specified in imageIdOverride, set this value to an empty string.

\n

One or two values can be provided.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "updateToLatestImageVersion": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute\n environment has an infrastructure update. The default value is false.

\n \n \n

If an AMI ID is specified in the imageId or imageIdOverride parameters or by the\n launch template specified in the launchTemplate parameter, this parameter is ignored. For more\n information on updating AMI IDs during an infrastructure update, see Updating the AMI ID in\n the Batch User Guide.

\n \n \n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

" + } + }, + "type": { + "target": "com.amazonaws.batch#CRType", + "traits": { + "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.

\n

When updating a compute environment, changing the type of a compute environment requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

" + } + }, + "imageId": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the\n custom AMI ID and use the default AMI ID, set this value to an empty string.

\n

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

\n " } } }, "traits": { - "smithy.api#documentation": "

An object representing the attributes of a compute environment that can be updated. For more information, see\n Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

An object representing the attributes of a compute environment that can be updated. For more information, see\n Updating compute environments\n in the Batch User Guide.

" } }, "com.amazonaws.batch#ContainerDetail": { @@ -780,7 +872,7 @@ "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the\n execution\n role that Batch can assume. For more information, see Batch execution IAM role in the\n Batch User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the\n Batch User Guide.

" } }, "volumes": { @@ -882,7 +974,7 @@ "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance. Or, alternatively, it must be configured on a different log server for remote logging options.\n For more information on the options for different supported log drivers, see Configure logging drivers in the Docker\n documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS\n container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.

\n " + "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance. Or, alternatively, it must be configured on a different log server for remote logging options.\n For more information on the options for different supported log drivers, see Configure logging drivers in the Docker\n documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS\n container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the\n Amazon Elastic Container Service Developer Guide.

\n " } }, "secrets": { @@ -917,7 +1009,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the vcpus parameter\n that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition. To override vCPU\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to VCPU and value set to the new value. For more information, see Can't override\n job definition resource requirements in the Batch User Guide.

" + "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the vcpus parameter\n that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition. To override vCPU\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to VCPU and value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.

" } }, "memory": { @@ -926,7 +1018,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the memory requirements\n specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the memory parameter set in the job definition, but doesn't override any memory\n requirement specified in the resourceRequirements structure in the job definition. To override memory\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to MEMORY and value set to the new value. For more information, see Can't override\n job definition resource requirements in the Batch User Guide.

" + "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the memory requirements\n specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the memory parameter set in the job definition, but doesn't override any memory\n requirement specified in the resourceRequirements structure in the job definition. To override memory\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to MEMORY and value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.

" } }, "command": { @@ -994,7 +1086,7 @@ "jobRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see\n IAM Roles for Tasks\n in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see\n IAM roles for tasks\n in the Amazon Elastic Container Service Developer Guide.

" } }, "executionRoleArn": { @@ -1066,7 +1158,7 @@ "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance (or on a different log server for remote logging options). For more information on the options for\n different supported log drivers, see Configure\n logging drivers in the Docker documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.

\n " + "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance (or on a different log server for remote logging options). For more information on the options for\n different supported log drivers, see Configure\n logging drivers in the Docker documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the\n Amazon Elastic Container Service Developer Guide.

\n " } }, "secrets": { @@ -1263,7 +1355,7 @@ "computeEnvironmentOrder": { "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#documentation": "

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler\n uses this parameter to determine which compute environment should run a specific job. Compute environments must be in\n the VALID state before you can associate them with a job queue. You can associate up to three compute\n environments with a job queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute\n environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n ", + "smithy.api#documentation": "

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler\n uses this parameter to determine which compute environment runs a specific job. Compute environments must be in\n the VALID state before you can associate them with a job queue. You can associate up to three compute\n environments with a job queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute\n environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n ", "smithy.api#required": {} } }, @@ -1344,6 +1436,9 @@ "smithy.api#documentation": "

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

\n

These tags can be updated or removed using the TagResource and UntagResource API operations.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateSchedulingPolicy.

" } }, "com.amazonaws.batch#CreateSchedulingPolicyResponse": { @@ -1488,6 +1583,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteSchedulingPolicy.

" } }, "com.amazonaws.batch#DeleteSchedulingPolicyResponse": { @@ -1552,7 +1650,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes one or more of your compute environments.

\n

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment\n operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances\n into.

", + "smithy.api#documentation": "

Describes one or more of your compute environments.

\n

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment\n operation to determine the ecsClusterArn that you launch your Amazon ECS container instances\n into.

", "smithy.api#http": { "method": "POST", "uri": "/v1/describecomputeenvironments", @@ -1852,6 +1950,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSchedulingPolicies.

" } }, "com.amazonaws.batch#DescribeSchedulingPoliciesResponse": { @@ -1929,13 +2030,13 @@ "accessPointId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the\n EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set\n on the EFS access point. If an access point is used, transit encryption must be enabled in the\n EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the\n Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the\n EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set\n on the EFS access point. If an access point is used, transit encryption must be enabled in the\n EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the\n Amazon Elastic File System User Guide.

" } }, "iam": { "target": "com.amazonaws.batch#EFSAuthorizationConfigIAM", "traits": { - "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.\n If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is\n omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the\n Batch User Guide. EFS IAM authorization requires that TransitEncryption be\n ENABLED and that a JobRoleArn is specified.

" + "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.\n If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is\n omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the\n Batch User Guide. EFS IAM authorization requires that TransitEncryption be\n ENABLED and that a JobRoleArn is specified.

" } } }, @@ -1998,7 +2099,7 @@ "transitEncryptionPort": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a\n transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be\n between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a\n transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be\n between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

" } }, "authorizationConfig": { @@ -2018,14 +2119,14 @@ "imageType": { "target": "com.amazonaws.batch#ImageType", "traits": { - "smithy.api#documentation": "

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI\n (ECS_AL2) is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all non-GPU instance families.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon Linux.\n Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

\n
\n
", + "smithy.api#documentation": "

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI\n (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type\n that's supported by Batch is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all non-GPU instance families.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon Linux.\n Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

\n
\n
", "smithy.api#required": {} } }, "imageIdOverride": { "target": "com.amazonaws.batch#ImageIdOverride", "traits": { - "smithy.api#documentation": "

The AMI ID used for instances launched in the compute environment that match the image type. This setting\n overrides the imageId set in the computeResource object.

" + "smithy.api#documentation": "

The AMI ID used for instances launched in the compute environment that match the image type. This setting\n overrides the imageId set in the computeResource object.

\n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

\n " } } }, @@ -2260,7 +2361,7 @@ "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { - "smithy.api#documentation": "

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding\n parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the\n Batch User Guide.

" + "smithy.api#documentation": "

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding\n parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the\n Batch User Guide.

" } }, "retryStrategy": { @@ -2390,7 +2491,7 @@ "status": { "target": "com.amazonaws.batch#JobStatus", "traits": { - "smithy.api#documentation": "

The current status for the job.

\n \n

If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the\n troubleshooting section of the Batch User Guide.

\n ", + "smithy.api#documentation": "

The current status for the job.

\n \n

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the\n troubleshooting section of the Batch User Guide.

\n ", "smithy.api#required": {} } }, @@ -2452,7 +2553,7 @@ "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The job definition that's used by this job.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job definition that's used by this job.

", "smithy.api#required": {} } }, @@ -2521,6 +2622,15 @@ "target": "com.amazonaws.batch#JobDetail" } }, + "com.amazonaws.batch#JobExecutionTimeoutMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 360 + } + } + }, "com.amazonaws.batch#JobQueueDetail": { "type": "structure", "members": { @@ -2789,7 +2899,7 @@ "version": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The version number of the launch template, $Latest, or $Default.

\n

If the value is $Latest, the latest version of the launch template is used. If the value is\n $Default, the default version of the launch template is used.

\n \n

After the compute environment is created, the launch template version that's used isn't changed, even if the\n $Default or $Latest version for the launch template is updated. To use a new launch\n template version, create a new compute environment, add the new compute environment to the existing job queue,\n remove the old compute environment from the job queue, and delete the old compute environment.

\n \n

Default: $Default.

" + "smithy.api#documentation": "

The version number of the launch template, $Latest, or $Default.

\n

If the value is $Latest, the latest version of the launch template is used. If the value is\n $Default, the default version of the launch template is used.

\n \n

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the\n compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute\n environment is set to true. During an infrastructure update, if either $Latest or\n $Default is specified, Batch re-evaluates the launch template version, and it might use a different\n version of the launch template. This is the case even if the launch template isn't specified in the update. When\n updating a compute environment, changing the launch template requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

Default: $Default.

" } } }, @@ -2833,7 +2943,7 @@ "swappiness": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A swappiness value of\n 0 causes swapping not to happen unless absolutely necessary. A swappiness value of\n 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter isn't specified, a default value of\n 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If\n maxSwap is set to 0, the container doesn't use swap. This parameter maps to the\n --memory-swappiness option to docker run.

\n

Consider the following when you use a per-container swap configuration.

\n \n \n

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be\n provided.

\n " + "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A swappiness value of\n 0 causes swapping not to happen unless absolutely necessary. A swappiness value of\n 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter isn't specified, a default value of\n 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If\n maxSwap is set to 0, the container doesn't use swap. This parameter maps to the\n --memory-swappiness option to docker run.

\n

Consider the following when you use a per-container swap configuration.

\n \n \n

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be\n provided.

\n " } } }, @@ -2990,6 +3100,9 @@ "smithy.api#documentation": "

The nextToken value that's returned from a previous paginated ListSchedulingPolicies\n request where maxResults was used and the results exceeded the value of that parameter. Pagination\n continues from the end of the previous results that returned the nextToken value. This value is\n null when there are no more results to\n return.

\n \n

This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ListSchedulingPolicies.

" } }, "com.amazonaws.batch#ListSchedulingPoliciesResponse": { @@ -3045,6 +3158,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ListTagsForResource.

" } }, "com.amazonaws.batch#ListTagsForResourceResponse": { @@ -3064,7 +3180,7 @@ "logDriver": { "target": "com.amazonaws.batch#LogDriver", "traits": { - "smithy.api#documentation": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the\n Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs that are running on Fargate resources are restricted to the awslogs and splunk\n log drivers.

\n \n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the\n Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker\n documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and\n options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker\n documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker\n documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker\n documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker\n documentation.

\n
\n
\n \n

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you\n can fork the Amazon ECS container agent project that's available on\n GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that\n you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

", + "smithy.api#documentation": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the\n Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs that are running on Fargate resources are restricted to the awslogs and splunk\n log drivers.

\n \n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the\n Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker\n documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and\n options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker\n documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker\n documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker\n documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker\n documentation.

\n
\n
\n \n

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you\n can fork the Amazon ECS container agent project that's available on\n GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that\n you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

", "smithy.api#required": {} } }, @@ -3077,7 +3193,7 @@ "secretOptions": { "target": "com.amazonaws.batch#SecretList", "traits": { - "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the\n Batch User Guide.

" + "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the\n Batch User Guide.

" } } }, @@ -3525,7 +3641,7 @@ "value": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs that are running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the Batch User Guide.

\n \n

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value.\n The supported values are 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

\n
\n
\n
\n
", + "smithy.api#documentation": "

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs that are running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n management in the Batch User Guide.

\n \n

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value.\n The supported values are 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

\n
\n
\n
\n
", "smithy.api#required": {} } }, @@ -3627,7 +3743,7 @@ "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

" + "smithy.api#documentation": "

The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services resources in Amazon Web Services General\n Reference.

" } } }, @@ -3821,7 +3937,7 @@ "containerOverrides": { "target": "com.amazonaws.batch#ContainerOverrides", "traits": { - "smithy.api#documentation": "

A list of container overrides in the JSON format that specify the name of a container in the specified job\n definition and the overrides it should receive. You can override the default command for a container, which is\n specified in the job definition or the Docker image, with a command override. You can also override\n existing environment variables on a container or add new environment variables to it with an environment\n override.

" + "smithy.api#documentation": "

A list of container overrides in the JSON format that specify the name of a container in the specified job\n definition and the overrides it receives. You can override the default command for a container, which is specified in\n the job definition or the Docker image, with a command override. You can also override\n existing environment variables on a container or add new environment variables to it with an environment\n override.

" } }, "nodeOverrides": { @@ -3948,6 +4064,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for TagResource.

" } }, "com.amazonaws.batch#TagResourceResponse": { @@ -4151,6 +4270,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for UntagResource.

" } }, "com.amazonaws.batch#UntagResourceResponse": { @@ -4201,7 +4323,7 @@ "unmanagedvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of vCPUs expected to be used for an unmanaged compute environment. This parameter should not\n be specified for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU\n capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity\n will be reserved.

" + "smithy.api#documentation": "

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Do not specify this\n parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU\n capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity\n will be reserved.

" } }, "computeResources": { @@ -4213,7 +4335,13 @@ "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.\n For more information, see Batch service IAM\n role in the Batch User Guide.

\n \n

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role.\n Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked\n role.

\n \n

If your specified role has a path other than /, then you must either specify the full role ARN\n (this is recommended) or prefix the role name with the path.

\n \n

Depending on how you created your Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

\n " + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.\n For more information, see Batch service IAM\n role in the Batch User Guide.

\n \n

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role.\n Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To\n update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see\n Updating compute\n environments in the Batch User Guide.

\n \n

If your specified role has a path other than /, then you must either specify the full role ARN\n (recommended) or prefix the role name with the path.

\n \n

Depending on how you created your Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

\n " + } + }, + "updatePolicy": { + "target": "com.amazonaws.batch#UpdatePolicy", + "traits": { + "smithy.api#documentation": "

Specifies the updated infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Updating\n compute environments in the Batch User Guide.

" } } }, @@ -4288,13 +4416,13 @@ "priority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order, for example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and\n Fargate compute environments can't be mixed.

" + "smithy.api#documentation": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order. For example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and\n Fargate compute environments can't be mixed.

" } }, "computeEnvironmentOrder": { "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#documentation": "

Details the set of compute environments mapped to a job queue and their order relative to each other. This is\n one of the parameters used by the job scheduler to determine which compute environment should run a given job.\n Compute environments must be in the VALID state before you can associate them with a job queue. All of\n the compute environments must be either EC2 (EC2 or SPOT) or Fargate\n (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n " + "smithy.api#documentation": "

Details the set of compute environments mapped to a job queue and their order relative to each other. This is\n one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute\n environments must be in the VALID state before you can associate them with a job queue. All of\n the compute environments must be either EC2 (EC2 or SPOT) or Fargate\n (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n " } } }, @@ -4319,6 +4447,26 @@ } } }, + "com.amazonaws.batch#UpdatePolicy": { + "type": "structure", + "members": { + "terminateJobsOnUpdate": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The\n default value is false.

" + } + }, + "jobExecutionTimeoutMinutes": { + "target": "com.amazonaws.batch#JobExecutionTimeoutMinutes", + "traits": { + "smithy.api#documentation": "

Specifies the job timeout, in minutes, when the compute environment infrastructure is updated. The default value\n is 30.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Infrastructure updates\n in the Batch User Guide.

" + } + }, "com.amazonaws.batch#UpdateSchedulingPolicy": { "type": "operation", "input": { @@ -4360,6 +4508,9 @@ "smithy.api#documentation": "

The fair share policy.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for UpdateSchedulingPolicy.

" } }, "com.amazonaws.batch#UpdateSchedulingPolicyResponse": { diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index 746a63d4042..51733b6f5c5 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -737,6 +737,9 @@ "input": { "target": "com.amazonaws.cloudwatch#DeleteAlarmsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#ResourceNotFound" @@ -1496,6 +1499,9 @@ "input": { "target": "com.amazonaws.cloudwatch#DisableAlarmActionsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disables the actions for the specified alarms. When an alarm's actions are disabled, the\n\t\t\talarm actions do not execute when the alarm state changes.

" } @@ -1560,6 +1566,9 @@ "input": { "target": "com.amazonaws.cloudwatch#EnableAlarmActionsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Enables the actions for the specified alarms.

" } @@ -2173,7 +2182,7 @@ "StatisticsConfigurations": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", "traits": { - "smithy.api#documentation": "

Each entry in this array displays information about one or more metrics that include extended statistics\n\t\t\tin the metric stream. For more information about extended statistics, see \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.

" + "smithy.api#documentation": "

Each entry in this array displays information about one or more metrics that include additional statistics\n\t\t\tin the metric stream. For more information about the additional statistics, see \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.

" } } } @@ -3720,20 +3729,20 @@ "IncludeMetrics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsIncludeMetrics", "traits": { - "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the extended statistics listed\n\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t100 pairs in the array.

\n\t\t

All metrics that match the combination of metric name and namespace will be streamed\n\t\twith the extended statistics, no matter their dimensions.

", + "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t100 pairs in the array.

\n\t\t

All metrics that match the combination of metric name and namespace will be streamed\n\t\twith the additional statistics, no matter their dimensions.

", "smithy.api#required": {} } }, "AdditionalStatistics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics", "traits": { - "smithy.api#documentation": "

The list of extended statistics that are to be streamed for the metrics listed\n\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n\t\t

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n\t\t

If the OutputFormat for the stream is json, \n\t\t\tthe valid values are include the abbreviations for all of the extended statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\ttm98, \n wm90, PR(:300), and so on.

", + "smithy.api#documentation": "

The list of additional statistics that are to be streamed for the metrics listed\n\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n\t\t

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n\t\t

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\ttm98, \n wm90, PR(:300), and so on.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for\n\t\t\tone metric that includes extended statistics in the stream. For more information about extended statistics, \n\t\t\tsee CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.

" + "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for\n\t\t\tone metric that includes additional statistics in the stream. For more information about statistics, \n\t\t\tsee CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.

" } }, "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations": { @@ -3754,7 +3763,7 @@ "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The metric namespace for the metric.

", + "smithy.api#documentation": "

The namespace of the metric.

", "smithy.api#required": {} } }, @@ -3767,7 +3776,7 @@ } }, "traits": { - "smithy.api#documentation": "

This object contains the information for one metric that is to streamed with \n\t\textended statistics.

" + "smithy.api#documentation": "

This object contains the information for one metric that is to be streamed with \n\t\tadditional statistics.

" } }, "com.amazonaws.cloudwatch#MetricWidget": { @@ -3956,6 +3965,9 @@ "input": { "target": "com.amazonaws.cloudwatch#PutCompositeAlarmInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#LimitExceededFault" @@ -4133,6 +4145,9 @@ "input": { "target": "com.amazonaws.cloudwatch#PutMetricAlarmInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#LimitExceededFault" @@ -4253,7 +4268,7 @@ "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

\n\t\t \n

Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\n\t\t\tmissing data even if you choose a different option for TreatMissingData. When an \n\t\t\tAWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

\n\t\t " } }, "EvaluateLowSampleCountPercentile": { @@ -4287,6 +4302,9 @@ "input": { "target": "com.amazonaws.cloudwatch#PutMetricDataInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" @@ -4350,7 +4368,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole permission\n\t\t\tand either the CloudWatchFullAccess\n\t\tpolicy or the cloudwatch:PutMetricStream \n\t\tpermission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use the\n\t\t\tStatisticsConfigurations parameter to have \n\t\t\tthe metric stream also send extended statistics in the stream. Streaming extended statistics incurs\n\t\t\tadditional costs. For more information, see Amazon CloudWatch Pricing.

\n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" + "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole permission\n\t\t\tand either the CloudWatchFullAccess\n\t\tpolicy or the cloudwatch:PutMetricStream \n\t\tpermission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use the\n\t\t\tStatisticsConfigurations parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. Streaming additional statistics incurs\n\t\t\tadditional costs. For more information, see Amazon CloudWatch Pricing.

\n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" } }, "com.amazonaws.cloudwatch#PutMetricStreamInput": { @@ -4405,7 +4423,7 @@ "StatisticsConfigurations": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", "traits": { - "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send extended statistics in the stream. This \n\t\t\tarray can have up to 100 members.

\n\t\t

For each entry in this array, you specify one or more metrics and the list of extended statistics to stream\n\t\t\tfor those metrics. The extended statistics that you can stream depend on the stream's OutputFormat.\n\t\t\tIf the OutputFormat is json, you can stream any extended statistic that is supported \n\t\t\tby CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat is \n\t\t\topentelemetry0.7, you can stream percentile statistics (p??).

" + "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. This \n\t\t\tarray can have up to 100 members.

\n\t\t

For each entry in this array, you specify one or more metrics and the list of additional statistics to stream\n\t\t\tfor those metrics. The additional statistics that you can stream depend on the stream's OutputFormat.\n\t\t\tIf the OutputFormat is json, you can stream any additional statistic that is supported \n\t\t\tby CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat is \n\t\t\topentelemetry0.7, you can stream percentile statistics such as p95, p99.9 and so on.

" } } } @@ -4550,6 +4568,9 @@ "input": { "target": "com.amazonaws.cloudwatch#SetAlarmStateInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidFormatFault" diff --git a/codegen/sdk/aws-models/connect.json b/codegen/sdk/aws-models/connect.json index 42916c096f8..ccd679316fc 100644 --- a/codegen/sdk/aws-models/connect.json +++ b/codegen/sdk/aws-models/connect.json @@ -330,6 +330,9 @@ { "target": "com.amazonaws.connect#AssociateLexBot" }, + { + "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlow" + }, { "target": "com.amazonaws.connect#AssociateQueueQuickConnects" }, @@ -339,6 +342,9 @@ { "target": "com.amazonaws.connect#AssociateSecurityKey" }, + { + "target": "com.amazonaws.connect#ClaimPhoneNumber" + }, { "target": "com.amazonaws.connect#CreateAgentStatus" }, @@ -438,6 +444,9 @@ { "target": "com.amazonaws.connect#DescribeInstanceStorageConfig" }, + { + "target": "com.amazonaws.connect#DescribePhoneNumber" + }, { "target": "com.amazonaws.connect#DescribeQueue" }, @@ -477,6 +486,9 @@ { "target": "com.amazonaws.connect#DisassociateLexBot" }, + { + "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlow" + }, { "target": "com.amazonaws.connect#DisassociateQueueQuickConnects" }, @@ -543,6 +555,9 @@ { "target": "com.amazonaws.connect#ListPhoneNumbers" }, + { + "target": "com.amazonaws.connect#ListPhoneNumbersV2" + }, { "target": "com.amazonaws.connect#ListPrompts" }, @@ -582,9 +597,15 @@ { "target": "com.amazonaws.connect#ListUsers" }, + { + "target": "com.amazonaws.connect#ReleasePhoneNumber" + }, { "target": "com.amazonaws.connect#ResumeContactRecording" }, + { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" + }, { "target": "com.amazonaws.connect#SearchVocabularies" }, @@ -657,6 +678,9 @@ { "target": "com.amazonaws.connect#UpdateInstanceStorageConfig" }, + { + "target": "com.amazonaws.connect#UpdatePhoneNumber" + }, { "target": "com.amazonaws.connect#UpdateQueueHoursOfOperation" }, @@ -741,6 +765,9 @@ "input": { "target": "com.amazonaws.connect#AssociateApprovedOriginRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -798,6 +825,9 @@ "input": { "target": "com.amazonaws.connect#AssociateBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -997,6 +1027,9 @@ "input": { "target": "com.amazonaws.connect#AssociateLambdaFunctionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1054,6 +1087,9 @@ "input": { "target": "com.amazonaws.connect#AssociateLexBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1106,11 +1142,75 @@ } } }, + "com.amazonaws.connect#AssociatePhoneNumberContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a contact flow with a phone number claimed to your Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/phone-number/{PhoneNumberId}/contact-flow", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#AssociateQueueQuickConnects": { "type": "operation", "input": { "target": "com.amazonaws.connect#AssociateQueueQuickConnectsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1173,6 +1273,9 @@ "input": { "target": "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1389,6 +1492,38 @@ "com.amazonaws.connect#AutoAccept": { "type": "boolean" }, + "com.amazonaws.connect#AvailableNumberSummary": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about available phone numbers.

" + } + }, + "com.amazonaws.connect#AvailableNumbersList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AvailableNumberSummary" + } + }, "com.amazonaws.connect#Boolean": { "type": "boolean" }, @@ -1524,6 +1659,160 @@ } } }, + "com.amazonaws.connect#ClaimPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ClaimPhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#ClaimPhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/claim", + "code": 200 + } + } + }, + "com.amazonaws.connect#ClaimPhoneNumberRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

", + "smithy.api#required": {} + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

", + "smithy.api#required": {} + } + }, + "PhoneNumberDescription": { + "target": "com.amazonaws.connect#PhoneNumberDescription", + "traits": { + "smithy.api#documentation": "

The description of the phone number.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#ClaimPhoneNumberResponse": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + } + } + }, + "com.amazonaws.connect#ClaimedPhoneNumberSummary": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "PhoneNumberDescription": { + "target": "com.amazonaws.connect#PhoneNumberDescription", + "traits": { + "smithy.api#documentation": "

The description of the phone number.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + }, + "PhoneNumberStatus": { + "target": "com.amazonaws.connect#PhoneNumberStatus", + "traits": { + "smithy.api#documentation": "

The status of the phone number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a phone number that has been claimed to your Amazon Connect instance.

" + } + }, "com.amazonaws.connect#ClientToken": { "type": "string", "traits": { @@ -3770,6 +4059,9 @@ "input": { "target": "com.amazonaws.connect#DeleteContactFlowRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#AccessDeniedException" @@ -3887,6 +4179,9 @@ "input": { "target": "com.amazonaws.connect#DeleteHoursOfOperationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -3939,6 +4234,9 @@ "input": { "target": "com.amazonaws.connect#DeleteInstanceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -3977,6 +4275,9 @@ "input": { "target": "com.amazonaws.connect#DeleteIntegrationAssociationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4026,6 +4327,9 @@ "input": { "target": "com.amazonaws.connect#DeleteQuickConnectRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4078,6 +4382,9 @@ "input": { "target": "com.amazonaws.connect#DeleteSecurityProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#AccessDeniedException" @@ -4136,6 +4443,9 @@ "input": { "target": "com.amazonaws.connect#DeleteUseCaseRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4193,6 +4503,9 @@ "input": { "target": "com.amazonaws.connect#DeleteUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4224,6 +4537,9 @@ "input": { "target": "com.amazonaws.connect#DeleteUserHierarchyGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4907,17 +5223,75 @@ } } }, - "com.amazonaws.connect#DescribeQueue": { + "com.amazonaws.connect#DescribePhoneNumber": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DescribeQueueRequest" + "target": "com.amazonaws.connect#DescribePhoneNumberRequest" }, "output": { - "target": "com.amazonaws.connect#DescribeQueueResponse" + "target": "com.amazonaws.connect#DescribePhoneNumberResponse" }, "errors": [ { - "target": "com.amazonaws.connect#InternalServiceException" + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details and status of a phone number that’s claimed to your Amazon Connect instance

", + "smithy.api#http": { + "method": "GET", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribePhoneNumberResponse": { + "type": "structure", + "members": { + "ClaimedPhoneNumberSummary": { + "target": "com.amazonaws.connect#ClaimedPhoneNumberSummary", + "traits": { + "smithy.api#documentation": "

Information about a phone number that's been claimed to your Amazon Connect instance.\n

" + } + } + } + }, + "com.amazonaws.connect#DescribeQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeQueueRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeQueueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" }, { "target": "com.amazonaws.connect#InvalidParameterException" @@ -5525,6 +5899,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateApprovedOriginRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5577,6 +5954,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5627,6 +6007,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateInstanceStorageConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5687,6 +6070,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateLambdaFunctionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5739,6 +6125,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateLexBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5794,11 +6183,69 @@ } } }, + "com.amazonaws.connect#DisassociatePhoneNumberContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/phone-number/{PhoneNumberId}/contact-flow", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpQuery": "instanceId", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#DisassociateQueueQuickConnects": { "type": "operation", "input": { "target": "com.amazonaws.connect#DisassociateQueueQuickConnectsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5858,6 +6305,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5917,6 +6367,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateSecurityKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -7660,6 +8113,15 @@ "smithy.api#documentation": "

Configuration information of a Kinesis video stream.

" } }, + "com.amazonaws.connect#LargeNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + }, "com.amazonaws.connect#LexBot": { "type": "structure", "members": { @@ -9085,6 +9547,155 @@ } } }, + "com.amazonaws.connect#ListPhoneNumbersSummary": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about phone numbers that have been claimed to your Amazon Connect instance.

" + } + }, + "com.amazonaws.connect#ListPhoneNumbersSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ListPhoneNumbersSummary" + } + }, + "com.amazonaws.connect#ListPhoneNumbersV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListPhoneNumbersV2Request" + }, + "output": { + "target": "com.amazonaws.connect#ListPhoneNumbersV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists phone numbers claimed to your Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ListPhoneNumbersSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListPhoneNumbersV2Request": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "PhoneNumberCountryCodes": { + "target": "com.amazonaws.connect#PhoneNumberCountryCodes", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberTypes": { + "target": "com.amazonaws.connect#PhoneNumberTypes", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "PhoneNumberPrefix": { + "target": "com.amazonaws.connect#PhoneNumberPrefix", + "traits": { + "smithy.api#documentation": "

The prefix of the phone number. If provided, it must contain + as part of the country code.

" + } + } + } + }, + "com.amazonaws.connect#ListPhoneNumbersV2Response": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "ListPhoneNumbersSummaryList": { + "target": "com.amazonaws.connect#ListPhoneNumbersSummaryList", + "traits": { + "smithy.api#documentation": "

Information about phone numbers that have been claimed to your Amazon Connect instances.

" + } + } + } + }, "com.amazonaws.connect#ListPrompts": { "type": "operation", "input": { @@ -10451,7 +11062,10 @@ } }, "com.amazonaws.connect#PhoneNumber": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#pattern": "^\\\\+[1-9]\\\\d{1,14}$" + } }, "com.amazonaws.connect#PhoneNumberCountryCode": { "type": "string", @@ -11420,12 +12034,28 @@ } } }, + "com.amazonaws.connect#PhoneNumberDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[\\W\\S_]*$" + } + }, "com.amazonaws.connect#PhoneNumberId": { "type": "string" }, - "com.amazonaws.connect#PhoneNumberQuickConnectConfig": { - "type": "structure", - "members": { + "com.amazonaws.connect#PhoneNumberPrefix": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\\\+?[0-9]{1,11}$" + } + }, + "com.amazonaws.connect#PhoneNumberQuickConnectConfig": { + "type": "structure", + "members": { "PhoneNumber": { "target": "com.amazonaws.connect#PhoneNumber", "traits": { @@ -11438,6 +12068,26 @@ "smithy.api#documentation": "

Contains information about a phone number for a quick connect.

" } }, + "com.amazonaws.connect#PhoneNumberStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.connect#PhoneNumberWorkflowStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "Message": { + "target": "com.amazonaws.connect#PhoneNumberWorkflowMessage", + "traits": { + "smithy.api#documentation": "

The status message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the phone number.

" + } + }, "com.amazonaws.connect#PhoneNumberSummary": { "type": "structure", "members": { @@ -11509,6 +12159,35 @@ } } }, + "com.amazonaws.connect#PhoneNumberWorkflowMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\W\\S_]*$" + } + }, + "com.amazonaws.connect#PhoneNumberWorkflowStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CLAIMED", + "name": "Claimed" + }, + { + "value": "IN_PROGRESS", + "name": "InProgress" + }, + { + "value": "FAILED", + "name": "Failed" + } + ] + } + }, "com.amazonaws.connect#PhoneType": { "type": "string", "traits": { @@ -12160,6 +12839,67 @@ } } }, + "com.amazonaws.connect#ReleasePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ReleasePhoneNumberRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#ReleasePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + } + }, "com.amazonaws.connect#ResourceConflictException": { "type": "structure", "members": { @@ -12571,6 +13311,105 @@ "smithy.api#documentation": "

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

" } }, + "com.amazonaws.connect#SearchAvailablePhoneNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for available phone numbers that you can claim to your Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/search-available", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AvailableNumbersList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

", + "smithy.api#required": {} + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

", + "smithy.api#required": {} + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

", + "smithy.api#required": {} + } + }, + "PhoneNumberPrefix": { + "target": "com.amazonaws.connect#PhoneNumberPrefix", + "traits": { + "smithy.api#documentation": "

The prefix of the phone number. If provided, it must contain + as part of the country code.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "AvailableNumbersList": { + "target": "com.amazonaws.connect#AvailableNumbersList", + "traits": { + "smithy.api#documentation": "

A list of available phone numbers that you can claim for your Amazon Connect instance.

" + } + } + } + }, "com.amazonaws.connect#SearchVocabularies": { "type": "operation", "input": { @@ -13694,6 +14533,9 @@ "input": { "target": "com.amazonaws.connect#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -13712,7 +14554,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, contact\n flows, agent status, and hours of operation.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, contact\n flows, agent status, hours of operation, and phone number.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -13847,6 +14689,9 @@ "input": { "target": "com.amazonaws.connect#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -13899,6 +14744,9 @@ "input": { "target": "com.amazonaws.connect#UpdateAgentStatusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14092,6 +14940,9 @@ "input": { "target": "com.amazonaws.connect#UpdateContactFlowContentRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14154,6 +15005,9 @@ "input": { "target": "com.amazonaws.connect#UpdateContactFlowMetadataRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14379,6 +15233,9 @@ "input": { "target": "com.amazonaws.connect#UpdateContactFlowNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14556,6 +15413,9 @@ "input": { "target": "com.amazonaws.connect#UpdateHoursOfOperationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14644,6 +15504,9 @@ "input": { "target": "com.amazonaws.connect#UpdateInstanceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14703,6 +15566,9 @@ "input": { "target": "com.amazonaws.connect#UpdateInstanceStorageConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14764,11 +15630,98 @@ } } }, + "com.amazonaws.connect#UpdatePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdatePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdatePhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdatePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#UpdatePhoneNumberResponse": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + } + } + }, "com.amazonaws.connect#UpdateQueueHoursOfOperation": { "type": "operation", "input": { "target": "com.amazonaws.connect#UpdateQueueHoursOfOperationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14828,6 +15781,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueMaxContactsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14887,6 +15843,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14954,6 +15913,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueOutboundCallerConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15013,6 +15975,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueStatusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15072,6 +16037,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQuickConnectConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15140,6 +16108,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQuickConnectNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15204,6 +16175,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15263,6 +16237,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15322,6 +16299,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -15389,6 +16369,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15448,6 +16431,9 @@ "input": { "target": "com.amazonaws.connect#UpdateSecurityProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15512,6 +16498,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserHierarchyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15543,6 +16532,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserHierarchyGroupNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -15632,6 +16624,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserHierarchyStructureRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15686,6 +16681,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserIdentityInfoRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15745,6 +16743,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserPhoneConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15804,6 +16805,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserRoutingProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15863,6 +16867,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserSecurityProfilesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 3b76f2454b2..2c469fb7ca1 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -426,7 +426,7 @@ "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult" }, "traits": { - "smithy.api#documentation": "

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint\n service.

" + "smithy.api#documentation": "

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

" } }, "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest": { @@ -4087,6 +4087,9 @@ "input": { "target": "com.amazonaws.ec2#AssociateDhcpOptionsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

\n

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

\n

For more information, see DHCP options sets\n in the Amazon Virtual Private Cloud User Guide.

" } @@ -4964,6 +4967,9 @@ "input": { "target": "com.amazonaws.ec2#AttachInternetGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and\n\t\t\tthe VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" } @@ -6697,6 +6703,9 @@ "input": { "target": "com.amazonaws.ec2#CancelConversionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all\n artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is\n in the process of transferring the final disk image, the command fails and returns an exception.

\n

For more information, see Importing a Virtual Machine Using the Amazon\n EC2 CLI.

" } @@ -6706,6 +6715,9 @@ "input": { "target": "com.amazonaws.ec2#CancelExportTaskRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Cancels an active export task. The request removes all artifacts of the export, including any partially-created\n Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the\n command fails and returns an error.

" } @@ -10485,7 +10497,7 @@ "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" }, "traits": { - "smithy.api#documentation": "

Provides information to Amazon Web Services about your VPN customer gateway device. The\n customer gateway is the appliance at your end of the VPN connection. (The device on the\n Amazon Web Services side of the VPN connection is the virtual private gateway.) You\n must provide the internet-routable IP address of the customer gateway's external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your\n network. If you don't have an ASN already, you can use a private ASN (in the 64512 -\n 65534 range).

\n \n

Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with\n the exception of the following:

\n \n \n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

\n \n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. Identical requests\n return information about the existing customer gateway and do not create new\n customer gateways.

\n " + "smithy.api#documentation": "

Provides information to Amazon Web Services about your VPN customer gateway device. The\n customer gateway is the appliance at your end of the VPN connection. (The device on the\n Amazon Web Services side of the VPN connection is the virtual private gateway.) You\n must provide the internet-routable IP address of the customer gateway's external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" } }, "com.amazonaws.ec2#CreateCustomerGatewayRequest": { @@ -11222,7 +11234,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.

\n \n

By default, Amazon EC2 shuts down and reboots the instance before creating the AMI to ensure that everything on \n the instance is stopped and in a consistent state during the creation process. If you're confident that your \n instance is in a consistent state appropriate for AMI creation, use the NoReboot \n parameter to prevent Amazon EC2 from shutting down and rebooting the instance.

\n \n \n \n \n \t\n \t

If 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.

\n \t

For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n\t

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \t \n\t\t\t\t\t

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n\t\t\t\t \n \n \n \n \t\n \t

If 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.

\n \t

For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateImageRequest": { @@ -11274,7 +11286,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "NoReboot", - "smithy.api#documentation": "

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. \n If the No Reboot option is set, Amazon EC2 doesn't shut down the instance before creating \n the image. Without a reboot, the AMI will be crash consistent (all the volumes are snapshotted \n at the same time), but not application consistent (all the operating system buffers are not flushed \n to disk before the snapshots are created).

", + "smithy.api#documentation": "

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \t \n\t\t\t\t\t

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n\t\t\t\t \n

Default: false (follow standard reboot process)

", "smithy.api#xmlName": "noReboot" } }, @@ -11488,7 +11500,7 @@ "target": "com.amazonaws.ec2#CreateIpamResult" }, "traits": { - "smithy.api#documentation": "

Create an IPAM. Amazon VCP IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.

\n

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" + "smithy.api#documentation": "

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use\n to automate your IP address management workflows including assigning, tracking,\n troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts\n throughout your Amazon Web Services Organization.

\n

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" } }, "com.amazonaws.ec2#CreateIpamPool": { @@ -11763,7 +11775,7 @@ "KeyType": { "target": "com.amazonaws.ec2#KeyType", "traits": { - "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.

\n

Default: rsa\n

" + "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

\n

Default: rsa\n

" } }, "TagSpecifications": { @@ -11784,7 +11796,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "

Creates a launch template. A launch template contains the parameters to launch an\n instance. When you launch an instance using RunInstances, you can\n specify a launch template instead of providing the launch parameters in the request. For\n more information, see Launching an instance from a\n launch template in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an\n instance. When you launch an instance using RunInstances, you can\n specify a launch template instead of providing the launch parameters in the request. For\n more information, see Launching an instance from a\n launch template in the Amazon Elastic Compute Cloud User Guide.

\n

If you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateLaunchTemplateRequest": { @@ -12219,6 +12231,9 @@ "input": { "target": "com.amazonaws.ec2#CreateNetworkAclEntryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of \n\t\t ingress rules and a separate set of egress rules.

\n\t\t

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

\n\t\t

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

\n

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" } @@ -13729,6 +13744,9 @@ "input": { "target": "com.amazonaws.ec2#CreateTagsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.

\n \n

For more information about tags, see Tagging Your Resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n Resource-Level Permissions for Amazon EC2 API Actions in the Amazon\n Elastic Compute Cloud User Guide.

" } @@ -14923,7 +14941,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by Amazon Web Services,\n an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, \n see VPC Endpoints in the\n Amazon Virtual Private Cloud User Guide.

\n

A gateway endpoint serves as a target for a route in your route table for\n traffic destined for the Amazon Web Service. You can specify an endpoint policy to attach \n to the endpoint, which will control access to the service from your VPC. You can also\n specify the VPC route tables that use the endpoint.

\n

An interface endpoint is a network interface in your subnet that\n serves as an endpoint for communicating with the specified service. You can specify the\n subnets in which to create an endpoint, and the security groups to associate with the\n endpoint network interface.

\n

A GatewayLoadBalancer endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.

\n

Use DescribeVpcEndpointServices to get a list of supported\n services.

" + "smithy.api#documentation": "

Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by Amazon Web Services,\n an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, \n see the Amazon Web Services PrivateLink Guide.

" } }, "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification": { @@ -15115,7 +15133,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC endpoint service configuration to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.

\n

To create an endpoint service configuration, you must first create one of the\n following for your service:

\n \n

For more information, see VPC Endpoint Services in the\n Amazon Virtual Private Cloud User Guide.

\n

If you set the private DNS name, you must prove that you own the private DNS domain\n name. For more information, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.

\n

Before you create an endpoint service, you must create one of the following for your service:

\n \n

If you set the private DNS name, you must prove that you own the private DNS domain\n name.

\n\t

For more information, see the Amazon Web Services PrivateLink \n\t Guide.

" } }, "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { @@ -15130,7 +15148,7 @@ "AcceptanceRequired": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted. To accept a request, use AcceptVpcEndpointConnections.

" + "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted manually.

" } }, "PrivateDnsName": { @@ -15451,6 +15469,9 @@ "input": { "target": "com.amazonaws.ec2#CreateVpnConnectionRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } @@ -15945,6 +15966,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteCustomerGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified customer gateway. You must delete the VPN connection before you\n can delete the customer gateway.

" } @@ -15977,6 +16001,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteDhcpOptionsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" } @@ -16366,6 +16393,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteInternetGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified internet gateway. You must detach the internet gateway from the\n\t\t\tVPC before you can delete it.

" } @@ -16401,7 +16431,7 @@ "target": "com.amazonaws.ec2#DeleteIpamResult" }, "traits": { - "smithy.api#documentation": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

\n \n

You cannot delete an IPAM if there are CIDRs provisioned to pools or if there are allocations in the pools within the IPAM. To deprovision pool \n CIDRs, see DeprovisionIpamPoolCidr. To release allocations, see ReleaseIpamPoolAllocation.\n

\n \n

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n

" + "smithy.api#documentation": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

\n

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n

" } }, "com.amazonaws.ec2#DeleteIpamPool": { @@ -16532,6 +16562,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteKeyPairRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified key pair, by removing the public key from Amazon EC2.

" } @@ -16948,6 +16981,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteNetworkAclRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" } @@ -16957,6 +16993,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteNetworkAclEntryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" } @@ -17200,6 +17239,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteNetworkInterfaceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified network interface. You must detach the network interface before you can delete it.

" } @@ -17289,6 +17331,9 @@ "input": { "target": "com.amazonaws.ec2#DeletePlacementGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified placement group. You must terminate all instances in the\n placement group before you can delete the placement group. For more information, see\n Placement groups in the Amazon EC2 User Guide.

" } @@ -17473,6 +17518,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified route from the specified route table.

" } @@ -17526,6 +17574,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteRouteTableRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" } @@ -17557,6 +17608,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSecurityGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.

" } @@ -17591,6 +17645,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSnapshotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Delete an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -17620,6 +17677,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the data feed for Spot Instances.

" } @@ -17645,6 +17705,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSubnetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" } @@ -17717,6 +17780,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteTagsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of resources.

\n

To list the current tags, use DescribeTags. For more information about tags, see \n Tagging Your Resources \n in the Amazon Elastic Compute Cloud User Guide.

" } @@ -18329,6 +18395,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVolumeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).

\n

The volume can remain in the deleting state for several minutes.

\n

For more information, see Delete an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -18358,6 +18427,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpcRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" } @@ -18572,6 +18644,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpnConnectionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified VPN connection.

\n

If you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.

\n

For certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.

" } @@ -18604,6 +18679,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified static route associated with a VPN connection between an\n existing virtual private gateway and a VPN customer gateway. The static route allows\n traffic to be routed from the virtual private gateway to the VPN customer\n gateway.

" } @@ -18635,6 +18713,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpnGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified virtual private gateway. You must first detach the virtual\n private gateway from the VPC. Note that you don't need to delete the virtual private\n gateway if you plan to delete and recreate the VPN connection between your VPC and your\n network.

" } @@ -18826,6 +18907,9 @@ "input": { "target": "com.amazonaws.ec2#DeregisterImageRequest" }, + "output": { + "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.

\n \n \n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is \n retained in the Recycle Bin for the specified retention period. For more information, \n see Recycle\n Bin in the Amazon Elastic Compute Cloud User Guide.

\n \n

When 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.

\n \t

When 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.

" } @@ -22395,7 +22479,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -24374,7 +24458,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -30611,6 +30695,9 @@ "input": { "target": "com.amazonaws.ec2#DetachInternetGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Detaches an internet gateway from a VPC, disabling connectivity between the internet\n\t\t\tand the VPC. The VPC must not contain any running instances with Elastic IP addresses or\n\t\t\tpublic IPv4 addresses.

" } @@ -30651,6 +30738,9 @@ "input": { "target": "com.amazonaws.ec2#DetachNetworkInterfaceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Detaches a network interface from an instance.

" } @@ -30743,6 +30833,9 @@ "input": { "target": "com.amazonaws.ec2#DetachVpnGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).

\n

You must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.

" } @@ -31506,6 +31599,9 @@ "input": { "target": "com.amazonaws.ec2#DisableVgwRoutePropagationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disables a virtual private gateway (VGW) from propagating routes to a specified route\n table of a VPC.

" } @@ -31627,6 +31723,9 @@ "input": { "target": "com.amazonaws.ec2#DisassociateAddressRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n\t\t\t

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" } @@ -31854,6 +31953,9 @@ "input": { "target": "com.amazonaws.ec2#DisassociateRouteTableRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disassociates a subnet or gateway from a route table.

\n\t\t

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.

" } @@ -32539,7 +32641,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is only supported on BlockDeviceMapping objects called \n by \n CreateImage.

", "smithy.api#xmlName": "outpostArn" } }, @@ -33793,6 +33895,9 @@ "input": { "target": "com.amazonaws.ec2#EnableVgwRoutePropagationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Enables a virtual private gateway (VGW) to propagate routes to the specified route\n table of a VPC.

" } @@ -33830,6 +33935,9 @@ "input": { "target": "com.amazonaws.ec2#EnableVolumeIORequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Enables I/O operations for a volume that had I/O operations disabled because the data on\n the volume was potentially inconsistent.

" } @@ -53788,6 +53896,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyIdFormatRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the ID format for the specified resource on a per-Region basis. You can\n specify that resources should receive longer IDs (17-character IDs) when they are\n created.

\n

This request can only be used to modify longer ID settings for resource types that\n are within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

This setting applies to the IAM user who makes the request; it does not apply to the\n entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If\n you're using this action as the root user, then these settings apply to the entire account,\n unless an IAM user explicitly overrides these settings for themselves. For more information,\n see Resource IDs \n in the Amazon Elastic Compute Cloud User Guide.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless\n of these settings and provided that they have permission to use the relevant\n Describe command for the resource type.

" } @@ -53816,6 +53927,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyIdentityIdFormatRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.

\n

This request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.

\n

This setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.

" } @@ -53857,6 +53971,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyImageAttributeRequest" }, + "output": { + "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.\n You can use the Attribute parameter to specify the attribute or one of the following parameters: \n Description or LaunchPermission.

\n \t

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.

" } @@ -53954,6 +54071,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyInstanceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.

\n

\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.

\n

To modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.

" } @@ -54956,6 +55076,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the specified network interface attribute. You can specify only one\n attribute at a time. You can use this action to attach and detach security groups from\n an existing EC2 instance.

" } @@ -55192,6 +55315,9 @@ "input": { "target": "com.amazonaws.ec2#ModifySnapshotAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

\n

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made\n public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -55390,6 +55516,9 @@ "input": { "target": "com.amazonaws.ec2#ModifySubnetAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n\t \n\t

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n\t \n\t

For more information about Amazon Web Services Outposts, see the following:

\n\t \n\t " } @@ -55989,7 +56118,7 @@ "target": "com.amazonaws.ec2#ModifyVolumeResult" }, "traits": { - "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) \n or Amazon EBS Elastic Volumes (Windows instances).

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or \n Extend a Windows file system.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitor the progress of volume modifications.

\n

With previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.

\n

If you reach the maximum volume modification rate per volume limit, you must wait\n at least six hours before applying further modifications to the affected EBS volume.

" + "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) \n or Amazon EBS Elastic Volumes (Windows instances).

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or \n Extend a Windows file system.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitor the progress of volume modifications.

\n

With previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.

\n

After modifying a volume, you must wait at least six hours and ensure that the volume \n is in the in-use or available state before you can modify the same \n volume. This is sometimes referred to as a cooldown period.

" } }, "com.amazonaws.ec2#ModifyVolumeAttribute": { @@ -55997,6 +56126,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyVolumeAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies a volume attribute.

\n

By default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the\n data consistency on your volume.

\n

You can change the default behavior to resume I/O operations. We recommend that you change\n this only for boot volumes or for volumes that are stateless or disposable.

" } @@ -56093,6 +56225,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyVpcAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the specified attribute of the specified VPC.

" } @@ -56132,7 +56267,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointResult" }, "traits": { - "smithy.api#documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see\n VPC\n Endpoints in the Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, \n see the Amazon Web Services PrivateLink \n Guide.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification": { @@ -56293,7 +56428,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n\t

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name. For more information, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n\t

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { @@ -56432,7 +56567,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" }, "traits": { - "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, \n\t IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

\n\t

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" + "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers \n\t (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

\n\t

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { @@ -60937,7 +61072,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the private DNS name for the service endpoint. For more information\n about these parameters, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Information about the private DNS name for the service endpoint.

" } }, "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch": { @@ -62042,6 +62177,9 @@ "input": { "target": "com.amazonaws.ec2#RebootInstancesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.

" } @@ -62777,6 +62915,9 @@ "input": { "target": "com.amazonaws.ec2#ReleaseAddressRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it.\n For more information, see AllocateAddress.

" } @@ -63074,6 +63215,9 @@ "input": { "target": "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" } @@ -63280,6 +63424,9 @@ "input": { "target": "com.amazonaws.ec2#ReplaceRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Replaces an existing route within a route table in a VPC. You must provide only one of\n the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC\n peering connection, network interface, egress-only internet gateway, or transit\n gateway.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" } @@ -63601,6 +63748,9 @@ "input": { "target": "com.amazonaws.ec2#ReportInstanceStatusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.

\n

Use of this action does not change the value returned by DescribeInstanceStatus.

" } @@ -63936,7 +64086,7 @@ } }, "traits": { - "smithy.api#documentation": "

The information to include in the launch template.

" + "smithy.api#documentation": "

The information to include in the launch template.

\n \n

You must specify at least one parameter for the launch template data.

\n " } }, "com.amazonaws.ec2#RequestSpotFleet": { @@ -65329,6 +65479,9 @@ "input": { "target": "com.amazonaws.ec2#ResetImageAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets an attribute of an AMI to its default value.

" } @@ -65379,6 +65532,9 @@ "input": { "target": "com.amazonaws.ec2#ResetInstanceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.

\n

The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.

" } @@ -65419,6 +65575,9 @@ "input": { "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets a network interface attribute. You can specify only one attribute at a time.

" } @@ -65461,6 +65620,9 @@ "input": { "target": "com.amazonaws.ec2#ResetSnapshotAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -67344,7 +67506,7 @@ "UserData": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The user data to make available to the instance. For more information, see Run commands on\n your Linux instance at launch and Run commands on your\n Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.

" + "smithy.api#documentation": "

The user data script to make available to the instance. For more information, see Run commands\n on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.

" } }, "AdditionalInfo": { @@ -69042,6 +69204,9 @@ "input": { "target": "com.amazonaws.ec2#SendDiagnosticInterruptRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).

\n\n

In general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.

\n\n

Before sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.

\n\n

For more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).

" } @@ -71696,7 +71861,7 @@ "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult" }, "traits": { - "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide.

" + "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server.

" } }, "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { @@ -76531,6 +76696,9 @@ "input": { "target": "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.

" } diff --git a/codegen/sdk/aws-models/elasticache.json b/codegen/sdk/aws-models/elasticache.json index 2155c94ab26..0d34cdf7178 100644 --- a/codegen/sdk/aws-models/elasticache.json +++ b/codegen/sdk/aws-models/elasticache.json @@ -727,7 +727,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -1083,7 +1083,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "com.amazonaws.elasticache#CacheNodeIdsList": { @@ -2081,7 +2081,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -2639,7 +2639,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -3344,6 +3344,9 @@ "input": { "target": "com.amazonaws.elasticache#DeleteCacheParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" @@ -3382,6 +3385,9 @@ "input": { "target": "com.amazonaws.elasticache#DeleteCacheSecurityGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" @@ -3420,6 +3426,9 @@ "input": { "target": "com.amazonaws.elasticache#DeleteCacheSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.elasticache#CacheSubnetGroupInUse" @@ -4562,7 +4571,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -4641,7 +4650,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -8715,7 +8724,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "StartTime": { @@ -8875,7 +8884,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -9445,7 +9454,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index ddd4c8d73f8..6e98b8b262d 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -69,6 +69,9 @@ { "target": "com.amazonaws.glue#BatchGetCrawlers" }, + { + "target": "com.amazonaws.glue#BatchGetCustomEntityTypes" + }, { "target": "com.amazonaws.glue#BatchGetDevEndpoints" }, @@ -111,6 +114,9 @@ { "target": "com.amazonaws.glue#CreateCrawler" }, + { + "target": "com.amazonaws.glue#CreateCustomEntityType" + }, { "target": "com.amazonaws.glue#CreateDatabase" }, @@ -174,6 +180,9 @@ { "target": "com.amazonaws.glue#DeleteCrawler" }, + { + "target": "com.amazonaws.glue#DeleteCustomEntityType" + }, { "target": "com.amazonaws.glue#DeleteDatabase" }, @@ -264,6 +273,9 @@ { "target": "com.amazonaws.glue#GetCrawlers" }, + { + "target": "com.amazonaws.glue#GetCustomEntityType" + }, { "target": "com.amazonaws.glue#GetDatabase" }, @@ -414,6 +426,9 @@ { "target": "com.amazonaws.glue#ListCrawlers" }, + { + "target": "com.amazonaws.glue#ListCustomEntityTypes" + }, { "target": "com.amazonaws.glue#ListDevEndpoints" }, @@ -1291,6 +1306,48 @@ } } }, + "com.amazonaws.glue#BatchGetCustomEntityTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#BatchGetCustomEntityTypesRequest" + }, + "output": { + "target": "com.amazonaws.glue#BatchGetCustomEntityTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ] + }, + "com.amazonaws.glue#BatchGetCustomEntityTypesRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.glue#CustomEntityTypeNames", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#BatchGetCustomEntityTypesResponse": { + "type": "structure", + "members": { + "CustomEntityTypes": { + "target": "com.amazonaws.glue#CustomEntityTypes" + }, + "CustomEntityTypesNotFound": { + "target": "com.amazonaws.glue#CustomEntityTypeNames" + } + } + }, "com.amazonaws.glue#BatchGetDevEndpoints": { "type": "operation", "input": { @@ -3575,6 +3632,18 @@ "smithy.api#documentation": "

Specifies the connections used by a job.

" } }, + "com.amazonaws.glue#ContextWords": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.glue#Crawl": { "type": "structure", "members": { @@ -4366,6 +4435,66 @@ "smithy.api#documentation": "

Specifies a custom CSV classifier for CreateClassifier to create.

" } }, + "com.amazonaws.glue#CreateCustomEntityType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateCustomEntityTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateCustomEntityTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ] + }, + "com.amazonaws.glue#CreateCustomEntityTypeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "RegexString": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "ContextWords": { + "target": "com.amazonaws.glue#ContextWords" + } + } + }, + "com.amazonaws.glue#CreateCustomEntityTypeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString" + } + } + }, "com.amazonaws.glue#CreateDatabase": { "type": "operation", "input": { @@ -6206,6 +6335,44 @@ "smithy.api#pattern": "^[^\\r\\n]$" } }, + "com.amazonaws.glue#CustomEntityType": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "RegexString": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "ContextWords": { + "target": "com.amazonaws.glue#ContextWords" + } + } + }, + "com.amazonaws.glue#CustomEntityTypeNames": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.glue#CustomEntityTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#CustomEntityType" + } + }, "com.amazonaws.glue#CustomPatterns": { "type": "string", "traits": { @@ -6845,6 +7012,51 @@ "type": "structure", "members": {} }, + "com.amazonaws.glue#DeleteCustomEntityType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteCustomEntityTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteCustomEntityTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ] + }, + "com.amazonaws.glue#DeleteCustomEntityTypeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#DeleteCustomEntityTypeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString" + } + } + }, "com.amazonaws.glue#DeleteDatabase": { "type": "operation", "input": { @@ -9341,6 +9553,57 @@ } } }, + "com.amazonaws.glue#GetCustomEntityType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetCustomEntityTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetCustomEntityTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ] + }, + "com.amazonaws.glue#GetCustomEntityTypeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#GetCustomEntityTypeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString" + }, + "RegexString": { + "target": "com.amazonaws.glue#NameString" + }, + "ContextWords": { + "target": "com.amazonaws.glue#ContextWords" + } + } + }, "com.amazonaws.glue#GetDataCatalogEncryptionSettings": { "type": "operation", "input": { @@ -13646,6 +13909,12 @@ "traits": { "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } + }, + "DPUSeconds": { + "target": "com.amazonaws.glue#NullableDouble", + "traits": { + "smithy.api#documentation": "

This field populates only when an Auto Scaling job run completes, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X and 2 for G.2X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity. Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity.

" + } } }, "traits": { @@ -14203,6 +14472,55 @@ } } }, + "com.amazonaws.glue#ListCustomEntityTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListCustomEntityTypesRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListCustomEntityTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListCustomEntityTypesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.glue#PaginationToken" + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize" + } + } + }, + "com.amazonaws.glue#ListCustomEntityTypesResponse": { + "type": "structure", + "members": { + "CustomEntityTypes": { + "target": "com.amazonaws.glue#CustomEntityTypes" + }, + "NextToken": { + "target": "com.amazonaws.glue#PaginationToken" + } + } + }, "com.amazonaws.glue#ListDevEndpoints": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/iotsitewise.json b/codegen/sdk/aws-models/iotsitewise.json index bedd1480c07..2e92f0002a4 100644 --- a/codegen/sdk/aws-models/iotsitewise.json +++ b/codegen/sdk/aws-models/iotsitewise.json @@ -70,6 +70,15 @@ { "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssets" }, + { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregates" + }, + { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValue" + }, + { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistory" + }, { "target": "com.amazonaws.iotsitewise#BatchPutAssetPropertyValue" }, @@ -1229,6 +1238,9 @@ "input": { "target": "com.amazonaws.iotsitewise#AssociateAssetsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -1300,6 +1312,9 @@ "input": { "target": "com.amazonaws.iotsitewise#AssociateTimeSeriesToAssetPropertyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -1348,279 +1363,1181 @@ "smithy.api#required": {} } }, - "propertyId": { - "target": "com.amazonaws.iotsitewise#ID", + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

", + "smithy.api#httpQuery": "propertyId", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#AssociatedAssetsSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#AssociatedAssetsSummary" + } + }, + "com.amazonaws.iotsitewise#AssociatedAssetsSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the asset, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}\n

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

The name of the asset.

", + "smithy.api#required": {} + } + }, + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model used to create the asset.

", + "smithy.api#required": {} + } + }, + "creationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the asset was created, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.iotsitewise#AssetStatus", + "traits": { + "smithy.api#documentation": "

The current status of the asset.

", + "smithy.api#required": {} + } + }, + "hierarchies": { + "target": "com.amazonaws.iotsitewise#AssetHierarchies", + "traits": { + "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a summary of an associated asset.

" + } + }, + "com.amazonaws.iotsitewise#Attribute": { + "type": "structure", + "members": { + "defaultValue": { + "target": "com.amazonaws.iotsitewise#DefaultValue", + "traits": { + "smithy.api#documentation": "

The default value of the asset model property attribute. All assets that you create from\n the asset model contain this attribute value. You can update an attribute's value after you\n create an asset. For more information, see Updating attribute values in the\n IoT SiteWise User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an asset attribute property. For more information, see\n Attributes in the IoT SiteWise User Guide.

" + } + }, + "com.amazonaws.iotsitewise#AuthMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IAM", + "name": "IAM" + }, + { + "value": "SSO", + "name": "SSO" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

", + "smithy.api#endpoint": { + "hostPrefix": "monitor." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{projectId}/assets/associate", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#AssetErrorDetails" + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest": { + "type": "structure", + "members": { + "projectId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the project to which to associate the assets.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIds": { + "target": "com.amazonaws.iotsitewise#IDs", + "traits": { + "smithy.api#documentation": "

The IDs of the assets to be associated to the project.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors", + "traits": { + "smithy.api#documentation": "

A list of associated error information, if any.

" + } + } + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

", + "smithy.api#endpoint": { + "hostPrefix": "monitor." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{projectId}/assets/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#AssetErrorDetails" + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest": { + "type": "structure", + "members": { + "projectId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the project from which to disassociate the assets.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIds": { + "target": "com.amazonaws.iotsitewise#IDs", + "traits": { + "smithy.api#documentation": "

The IDs of the assets to be disassociated from the project.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors", + "traits": { + "smithy.api#documentation": "

A list of associated error information, if any.

" + } + } + } + }, + "com.amazonaws.iotsitewise#BatchEntryCompletionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregates": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. \n For more information, see Querying\n aggregates in the IoT SiteWise User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/properties/batch/aggregates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset in which the asset property was created.

" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

" + } + }, + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "traits": { + "smithy.api#documentation": "

The alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n IoT SiteWise User Guide.

" + } + }, + "aggregateTypes": { + "target": "com.amazonaws.iotsitewise#AggregateTypes", + "traits": { + "smithy.api#documentation": "

The data aggregating function.

", + "smithy.api#required": {} + } + }, + "resolution": { + "target": "com.amazonaws.iotsitewise#Resolution", + "traits": { + "smithy.api#documentation": "

The time interval over which to aggregate data.

", + "smithy.api#required": {} + } + }, + "startDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "endDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "qualities": { + "target": "com.amazonaws.iotsitewise#Qualities", + "traits": { + "smithy.api#documentation": "

The quality by which to filter asset data.

" + } + }, + "timeOrdering": { + "target": "com.amazonaws.iotsitewise#TimeOrdering", + "traits": { + "smithy.api#documentation": "

The chronological sorting order of the requested information.

\n

Default: ASCENDING\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information for an asset property aggregate entry that is associated with the \n BatchGetAssetPropertyAggregates API.

\n

To identify an asset property, you must specify one of the following:

\n " + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ResourceNotFoundException", + "name": "ResourceNotFoundException" + }, + { + "value": "InvalidRequestException", + "name": "InvalidRequestException" + }, + { + "value": "AccessDeniedException", + "name": "AccessDeniedException" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntry": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The associated error message.

", + "smithy.api#required": {} + } + }, + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains error information for an asset property aggregate entry that is associated with the \n BatchGetAssetPropertyAggregates API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorInfo": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorTimestamp": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the error occurred, in Unix epoch time.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the error code and the timestamp for an asset property aggregate entry that is associated with the \n BatchGetAssetPropertyAggregates API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntries", + "traits": { + "smithy.api#documentation": "

The list of asset property aggregate entries for the batch get request. \n You can specify up to 16 entries per request.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

\n " + } + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesResponse": { + "type": "structure", + "members": { + "errorEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntries", + "traits": { + "smithy.api#documentation": "

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

", + "smithy.api#required": {} + } + }, + "successEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntries", + "traits": { + "smithy.api#documentation": "

A list of entries that were processed successfully by this batch request. Each success entry\n contains the entryId of the entry that succeeded and the latest query result.

", + "smithy.api#required": {} + } + }, + "skippedEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntries", + "traits": { + "smithy.api#documentation": "

A list of entries that were not processed by this batch request. \n because these entries had been completely processed by previous paginated requests. \n Each skipped entry contains the entryId of the entry that skipped.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "completionStatus": { + "target": "com.amazonaws.iotsitewise#BatchEntryCompletionStatus", + "traits": { + "smithy.api#documentation": "

The completion status of each entry that is associated with the \n BatchGetAssetPropertyAggregates API.

", + "smithy.api#required": {} + } + }, + "errorInfo": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorInfo", + "traits": { + "smithy.api#documentation": "

The error information, such as the error code and the timestamp.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information for an entry that has been processed by the previous \n BatchGetAssetPropertyAggregates request.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "aggregatedValues": { + "target": "com.amazonaws.iotsitewise#AggregatedValues", + "traits": { + "smithy.api#documentation": "

The requested aggregated asset property values (for example, average, minimum, and maximum).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains success information for an entry that is associated with the \n BatchGetAssetPropertyAggregates API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the current value for one or more asset properties. For more information, see Querying\n current values in the IoT SiteWise User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/properties/batch/latest", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset in which the asset property was created.

" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

" + } + }, + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "traits": { + "smithy.api#documentation": "

The alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n IoT SiteWise User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information for an asset property value entry that is associated with the \n BatchGetAssetPropertyValue API.

\n

To identify an asset property, you must specify one of the following:

\n " + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ResourceNotFoundException", + "name": "ResourceNotFoundException" + }, + { + "value": "InvalidRequestException", + "name": "InvalidRequestException" + }, + { + "value": "AccessDeniedException", + "name": "AccessDeniedException" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntry": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The associated error message.

", + "smithy.api#required": {} + } + }, + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains error information for an asset property value entry that is associated with the \n BatchGetAssetPropertyValue API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorInfo": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorTimestamp": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the error occurred, in Unix epoch time.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The error information, such as the error code and the timestamp.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the historical values for one or more asset properties. For more information, see Querying\n historical values in the IoT SiteWise User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/properties/batch/history", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset in which the asset property was created.

" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

" + } + }, + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "traits": { + "smithy.api#documentation": "

The alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n IoT SiteWise User Guide.

" + } + }, + "startDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

" + } + }, + "endDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

" + } + }, + "qualities": { + "target": "com.amazonaws.iotsitewise#Qualities", + "traits": { + "smithy.api#documentation": "

The quality by which to filter asset data.

" + } + }, + "timeOrdering": { + "target": "com.amazonaws.iotsitewise#TimeOrdering", + "traits": { + "smithy.api#documentation": "

The chronological sorting order of the requested information.

\n

Default: ASCENDING\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information for an asset property historical value entry that is associated with the \n BatchGetAssetPropertyValueHistory API.

\n

To identify an asset property, you must specify one of the following:

\n " + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ResourceNotFoundException", + "name": "ResourceNotFoundException" + }, + { + "value": "InvalidRequestException", + "name": "InvalidRequestException" + }, + { + "value": "AccessDeniedException", + "name": "AccessDeniedException" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntry": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The associated error message.

", + "smithy.api#required": {} + } + }, + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorInfo": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorTimestamp": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the error occurred, in Unix epoch time.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The error information, such as the error code and the timestamp.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntries", + "traits": { + "smithy.api#documentation": "

The list of asset property historical value entries for the batch get request. \n You can specify up to 16 entries per request.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", "traits": { - "smithy.api#documentation": "

The ID of the asset property.

", - "smithy.api#httpQuery": "propertyId", - "smithy.api#required": {} + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

" } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "maxResults": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryMaxResults", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

\n " } } } }, - "com.amazonaws.iotsitewise#AssociatedAssetsSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.iotsitewise#AssociatedAssetsSummary" - } - }, - "com.amazonaws.iotsitewise#AssociatedAssetsSummary": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryResponse": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the asset.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.iotsitewise#ARN", + "errorEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntries", "traits": { - "smithy.api#documentation": "

The ARN of the asset, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}\n

", + "smithy.api#documentation": "

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "successEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntries", "traits": { - "smithy.api#documentation": "

The name of the asset.

", + "smithy.api#documentation": "

A list of entries that were processed successfully by this batch request. Each success entry\n contains the entryId of the entry that succeeded and the latest query result.

", "smithy.api#required": {} } }, - "assetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "skippedEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntries", "traits": { - "smithy.api#documentation": "

The ID of the asset model used to create the asset.

", + "smithy.api#documentation": "

A list of entries that were not processed by this batch request. \n because these entries had been completely processed by previous paginated requests. \n Each skipped entry contains the entryId of the entry that skipped.

", "smithy.api#required": {} } }, - "creationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", "traits": { - "smithy.api#documentation": "

The date the asset was created, in Unix epoch time.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" } - }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The ID of the entry.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.iotsitewise#AssetStatus", + "completionStatus": { + "target": "com.amazonaws.iotsitewise#BatchEntryCompletionStatus", "traits": { - "smithy.api#documentation": "

The current status of the asset.

", + "smithy.api#documentation": "

The completion status of each entry that is associated with the \n BatchGetAssetPropertyValueHistory API.

", "smithy.api#required": {} } }, - "hierarchies": { - "target": "com.amazonaws.iotsitewise#AssetHierarchies", + "errorInfo": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorInfo", "traits": { - "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The error information, such as the error code and the timestamp.

" } } }, "traits": { - "smithy.api#documentation": "

Contains a summary of an associated asset.

" + "smithy.api#documentation": "

Contains information for an entry that has been processed by the previous \n BatchGetAssetPropertyValueHistory request.

" } }, - "com.amazonaws.iotsitewise#Attribute": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntry": { "type": "structure", "members": { - "defaultValue": { - "target": "com.amazonaws.iotsitewise#DefaultValue", + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

The default value of the asset model property attribute. All assets that you create from\n the asset model contain this attribute value. You can update an attribute's value after you\n create an asset. For more information, see Updating attribute values in the\n IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetPropertyValueHistory": { + "target": "com.amazonaws.iotsitewise#AssetPropertyValueHistory", + "traits": { + "smithy.api#documentation": "

The requested historical values for the specified asset property.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains an asset attribute property. For more information, see\n Attributes in the IoT SiteWise User Guide.

" + "smithy.api#documentation": "

Contains success information for an entry that is associated with the \n BatchGetAssetPropertyValueHistory API.

" } }, - "com.amazonaws.iotsitewise#AuthMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IAM", - "name": "IAM" - }, - { - "value": "SSO", - "name": "SSO" + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntries", + "traits": { + "smithy.api#documentation": "

The list of asset property value entries for the batch get request. \n You can specify up to 16 entries per request.

", + "smithy.api#required": {} } - ] - } - }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssets": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest" - }, - "output": { - "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotsitewise#InternalFailureException" - }, - { - "target": "com.amazonaws.iotsitewise#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotsitewise#LimitExceededException" - }, - { - "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotsitewise#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

", - "smithy.api#endpoint": { - "hostPrefix": "monitor." }, - "smithy.api#http": { - "method": "POST", - "uri": "/projects/{projectId}/assets/associate", - "code": 200 + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

" + } } } }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.iotsitewise#AssetErrorDetails" - } - }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueResponse": { "type": "structure", "members": { - "projectId": { - "target": "com.amazonaws.iotsitewise#ID", + "errorEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntries", "traits": { - "smithy.api#documentation": "

The ID of the project to which to associate the assets.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

", "smithy.api#required": {} } }, - "assetIds": { - "target": "com.amazonaws.iotsitewise#IDs", + "successEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntries", "traits": { - "smithy.api#documentation": "

The IDs of the assets to be associated to the project.

", + "smithy.api#documentation": "

A list of entries that were processed successfully by this batch request. Each success entry\n contains the entryId of the entry that succeeded and the latest query result.

", "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "skippedEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntries", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

A list of entries that were not processed by this batch request. \n because these entries had been completely processed by previous paginated requests. \n Each skipped entry contains the entryId of the entry that skipped.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse": { - "type": "structure", - "members": { - "errors": { - "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors", + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", "traits": { - "smithy.api#documentation": "

A list of associated error information, if any.

" + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" } } } }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssets": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest" - }, - "output": { - "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotsitewise#InternalFailureException" - }, - { - "target": "com.amazonaws.iotsitewise#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotsitewise#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

", - "smithy.api#endpoint": { - "hostPrefix": "monitor." - }, - "smithy.api#http": { - "method": "POST", - "uri": "/projects/{projectId}/assets/disassociate", - "code": 200 - } - } - }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntries": { "type": "list", "member": { - "target": "com.amazonaws.iotsitewise#AssetErrorDetails" + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntry" } }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntry": { "type": "structure", "members": { - "projectId": { - "target": "com.amazonaws.iotsitewise#ID", + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

The ID of the project from which to disassociate the assets.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of the entry.

", "smithy.api#required": {} } }, - "assetIds": { - "target": "com.amazonaws.iotsitewise#IDs", + "completionStatus": { + "target": "com.amazonaws.iotsitewise#BatchEntryCompletionStatus", "traits": { - "smithy.api#documentation": "

The IDs of the assets to be disassociated from the project.

", + "smithy.api#documentation": "

The completion status of each entry that is associated with the \n BatchGetAssetPropertyValue request.

", "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "errorInfo": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorInfo", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The error information, such as the error code and the timestamp.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains information for an entry that has been processed by the previous \n BatchGetAssetPropertyValue request.

" } }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntry": { "type": "structure", "members": { - "errors": { - "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors", + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

A list of associated error information, if any.

" + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} } + }, + "assetPropertyValue": { + "target": "com.amazonaws.iotsitewise#AssetPropertyValue" } + }, + "traits": { + "smithy.api#documentation": "

Contains success information for an entry that is associated with the \n BatchGetAssetPropertyValue API.

" } }, "com.amazonaws.iotsitewise#BatchPutAssetPropertyError": { @@ -3079,6 +3996,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DeleteGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#InternalFailureException" @@ -3252,6 +4172,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DeleteTimeSeriesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -4774,6 +5697,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DisassociateAssetsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -4842,6 +5768,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DisassociateTimeSeriesFromAssetPropertyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -5210,6 +6139,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "aggregatedValues", "pageSize": "maxResults" } } @@ -5393,6 +6323,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetPropertyValueHistory", "pageSize": "maxResults" } } @@ -5558,6 +6489,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "interpolatedAssetPropertyValues", "pageSize": "maxResults" } } @@ -6073,6 +7005,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "accessPolicySummaries", "pageSize": "maxResults" } } @@ -6181,6 +7114,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetModelSummaries", "pageSize": "maxResults" } } @@ -6257,6 +7191,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetRelationshipSummaries", "pageSize": "maxResults" } } @@ -6349,6 +7284,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetSummaries", "pageSize": "maxResults" } } @@ -6454,6 +7390,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetSummaries", "pageSize": "maxResults" } } @@ -6549,6 +7486,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "dashboardSummaries", "pageSize": "maxResults" } } @@ -6630,6 +7568,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "gatewaySummaries", "pageSize": "maxResults" } } @@ -6703,6 +7642,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "portalSummaries", "pageSize": "maxResults" } } @@ -6775,6 +7715,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetIds", "pageSize": "maxResults" } } @@ -6856,6 +7797,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "projectSummaries", "pageSize": "maxResults" } } @@ -7007,6 +7949,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "TimeSeriesSummaries", "pageSize": "maxResults" } } @@ -7749,10 +8692,7 @@ } }, "com.amazonaws.iotsitewise#PropertyValueStringValue": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" - } + "type": "string" }, "com.amazonaws.iotsitewise#PutAssetPropertyValueEntries": { "type": "list", @@ -8383,7 +9323,7 @@ "smithy.api#box": {}, "smithy.api#range": { "min": 1, - "max": 31556889864403199 + "max": 9223372036854774 } } }, @@ -8918,6 +9858,9 @@ "input": { "target": "com.amazonaws.iotsitewise#UpdateAssetPropertyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -9109,6 +10052,9 @@ "input": { "target": "com.amazonaws.iotsitewise#UpdateGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" diff --git a/codegen/sdk/aws-models/iottwinmaker.json b/codegen/sdk/aws-models/iottwinmaker.json index 12a064c404b..ae1129673a8 100644 --- a/codegen/sdk/aws-models/iottwinmaker.json +++ b/codegen/sdk/aws-models/iottwinmaker.json @@ -2132,10 +2132,16 @@ } }, "startTime": { - "target": "com.amazonaws.iottwinmaker#Time" + "target": "com.amazonaws.iottwinmaker#Time", + "traits": { + "smithy.api#documentation": "

The ISO8601 DateTime of the earliest property value to return.

\n

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

" + } }, "endTime": { - "target": "com.amazonaws.iottwinmaker#Time" + "target": "com.amazonaws.iottwinmaker#Time", + "traits": { + "smithy.api#documentation": "

The ISO8601 DateTime of the latest property value to return.

\n

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

" + } } } }, @@ -2444,7 +2450,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_-]+$" + "smithy.api#pattern": "^[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_-]+$" } }, "com.amazonaws.iottwinmaker#Integer": { @@ -2590,7 +2596,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that filters items in a list of component types.

" + "smithy.api#documentation": "

An object that filters items in a list of component types.

\n \n

Only one object is accepted as a valid input.

\n " } }, "com.amazonaws.iottwinmaker#ListComponentTypesFilters": { @@ -2746,7 +2752,7 @@ "filters": { "target": "com.amazonaws.iottwinmaker#ListEntitiesFilters", "traits": { - "smithy.api#documentation": "

A list of objects that filter the request.

" + "smithy.api#documentation": "

A list of objects that filter the request.

\n \n

Only one object is accepted as a valid input.

\n " } }, "maxResults": { @@ -3415,7 +3421,10 @@ } }, "time": { - "target": "com.amazonaws.iottwinmaker#Time" + "target": "com.amazonaws.iottwinmaker#Time", + "traits": { + "smithy.api#documentation": "

ISO8601 DateTime of a value for a time series property.

\n

The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].

\n \n

\n Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]

" + } } }, "traits": { @@ -3440,7 +3449,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that specifies information about time series property values.

" + "smithy.api#documentation": "

An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.

" } }, "com.amazonaws.iottwinmaker#PropertyValueHistory": { diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index f2dcdc80aed..7101e463c55 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -1009,7 +1009,7 @@ "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for an Amazon VPC to connect to your Box. For \n more information, see Configuring a VPC.

" + "smithy.api#documentation": "

Configuration information for an Amazon VPC to connect to your Box. For \n more information, see Configuring a VPC.

" } } }, @@ -1066,6 +1066,9 @@ "input": { "target": "com.amazonaws.kendra#ClearQuerySuggestionsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -2660,6 +2663,12 @@ "traits": { "smithy.api#documentation": "

Provides the configuration information to connect to Box as your data source.

" } + }, + "QuipConfiguration": { + "target": "com.amazonaws.kendra#QuipConfiguration", + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to Quip as your \n data source.

" + } } }, "traits": { @@ -3121,6 +3130,10 @@ { "value": "BOX", "name": "BOX" + }, + { + "value": "QUIP", + "name": "QUIP" } ] } @@ -3248,6 +3261,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteDataSourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3351,6 +3367,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteFaqRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3399,6 +3418,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteIndexRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3440,6 +3462,9 @@ "input": { "target": "com.amazonaws.kendra#DeletePrincipalMappingRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3500,6 +3525,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteQuerySuggestionsBlockListRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3548,6 +3576,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteThesaurusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -5166,6 +5197,16 @@ "smithy.api#documentation": "

Document metadata files that contain information such as the\n document access control information, source URI, document author,\n and custom attributes. Each metadata file contains metadata about a\n single document.

" } }, + "com.amazonaws.kendra#Domain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^(?!-)[A-Za-z0-9-].*(?The configuration information to connect to your Quip data source domain.

", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the\n key-value pairs\n that are\n required to connect to your Quip file system. Windows is currently the\n only supported type. The secret must contain a JSON structure with the following\n keys:

\n ", + "smithy.api#required": {} + } + }, + "CrawlFileComments": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

Specify whether to crawl file comments in your Quip data source. \n You can specify one or more of these options.

" + } + }, + "CrawlChatRooms": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

Specify whether to crawl chat rooms in your Quip data source. \n You can specify one or more of these options.

" + } + }, + "CrawlAttachments": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

Specify whether to crawl attachments in your Quip data source. \n You can specify one or more of these options.

" + } + }, + "FolderIds": { + "target": "com.amazonaws.kendra#FolderIdList", + "traits": { + "smithy.api#documentation": "

The identifier of the Quip folder IDs to index.

" + } + }, + "ThreadFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip threads.

" + } + }, + "MessageFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip messages.

" + } + }, + "AttachmentFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip attachments.

" + } + }, + "InclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to include certain files in your Quip file\n system. Files that match the patterns are included in the index. Files that don't match\n the patterns are excluded from the index. If a file matches both an inclusion pattern\n and an exclusion pattern, the exclusion pattern takes\n precedence,\n and the file isn't included in the index.

" + } + }, + "ExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files in your Quip file\n system. Files that match the patterns are excluded from the index. Files that don’t\n match the patterns are included in the index. If a file matches both an inclusion\n pattern and an exclusion pattern, the exclusion pattern takes\n precedence,\n and the file isn't included in the index.

" + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for connecting to an Amazon Virtual Private Cloud\n (VPC)\n for your Quip. Your Quip instance must reside inside your VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to Quip as your data source.

" + } + }, "com.amazonaws.kendra#ReadAccessType": { "type": "string", "traits": { @@ -10273,6 +10414,9 @@ "input": { "target": "com.amazonaws.kendra#StopDataSourceSyncJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -10336,6 +10480,9 @@ "input": { "target": "com.amazonaws.kendra#SubmitFeedbackRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -10903,6 +11050,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateDataSourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -10993,6 +11143,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateExperienceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11065,6 +11218,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateIndexRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11157,6 +11313,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateQuerySuggestionsBlockListRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11229,6 +11388,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateQuerySuggestionsConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11300,6 +11462,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateThesaurusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" diff --git a/codegen/sdk/aws-models/kms.json b/codegen/sdk/aws-models/kms.json index 96064356c94..6808c455634 100644 --- a/codegen/sdk/aws-models/kms.json +++ b/codegen/sdk/aws-models/kms.json @@ -160,7 +160,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS\n key is Disabled. To enable the KMS key, use EnableKey.

\n

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" + "smithy.api#documentation": "

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS\n key is Disabled. To enable the KMS key, use EnableKey.

\n

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" } }, "com.amazonaws.kms#CancelKeyDeletionRequest": { @@ -409,6 +409,9 @@ "input": { "target": "com.amazonaws.kms#CreateAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#AlreadyExistsException" @@ -433,7 +436,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a friendly name for a KMS key.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and\n GenerateDataKey. You can also change the KMS key that's associated with\n the alias (UpdateAlias) or delete the alias (DeleteAlias)\n at any time. These operations don't affect the underlying KMS key.

\n

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each\n alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.\n A valid KMS key is required. You can't create an alias without a KMS key.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Creates a friendly name for a KMS key.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and\n GenerateDataKey. You can also change the KMS key that's associated with\n the alias (UpdateAlias) or delete the alias (DeleteAlias)\n at any time. These operations don't affect the underlying KMS key.

\n

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each\n alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.\n A valid KMS key is required. You can't create an alias without a KMS key.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateAliasRequest": { @@ -569,7 +572,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a grant to a KMS key.

\n

A grant is a policy instrument that allows Amazon Web Services principals to use\n KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key,\n grants are considered along with key policies and IAM policies. Grants are often used for\n temporary permissions because you can create one, use its permissions, and delete it without\n changing your key policies or IAM policies.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

The CreateGrant operation returns a GrantToken and a\n GrantId.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Adds a grant to a KMS key.

\n

A grant is a policy instrument that allows Amazon Web Services principals to use\n KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key,\n grants are considered along with key policies and IAM policies. Grants are often used for\n temporary permissions because you can create one, use its permissions, and delete it without\n changing your key policies or IAM policies.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

The CreateGrant operation returns a GrantToken and a\n GrantId.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateGrantRequest": { @@ -598,14 +601,14 @@ "Operations": { "target": "com.amazonaws.kms#GrantOperationList", "traits": { - "smithy.api#documentation": "

A list of operations that the grant permits.

\n

The operation must be supported on the KMS key. For example, you cannot create a grant for\n a symmetric KMS key that allows the Sign operation, or a grant for an\n asymmetric KMS key that allows the GenerateDataKey operation. If you try,\n KMS returns a ValidationError exception. For details, see Grant\n operations in the Key Management Service Developer Guide.

", + "smithy.api#documentation": "

A list of operations that the grant permits.

\n

This list must include only operations that are permitted in a grant. Also, the operation\n must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key\n that allows the GenerateDataKey operation. If you try, KMS returns a\n ValidationError exception. For details, see Grant operations in the\n Key Management Service Developer Guide.

", "smithy.api#required": {} } }, "Constraints": { "target": "com.amazonaws.kms#GrantConstraints", "traits": { - "smithy.api#documentation": "

Specifies a grant constraint.

\n

KMS supports the EncryptionContextEquals and\n EncryptionContextSubset grant constraints. Each constraint value can include up\n to 8 encryption context pairs. The encryption context value in each constraint cannot exceed\n 384 characters.

\n

These grant constraints allow the permissions in the grant only when the encryption\n context in the request matches (EncryptionContextEquals) or includes\n (EncryptionContextSubset) the encryption context specified in this structure.\n For information about grant constraints, see Using grant\n constraints in the Key Management Service Developer Guide. For more information about encryption context,\n see Encryption\n Context in the \n Key Management Service Developer Guide\n .

\n

The encryption context grant constraints are supported only on operations that include an\n encryption context. You cannot use an encryption context grant constraint for cryptographic\n operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

" + "smithy.api#documentation": "

Specifies a grant constraint.

\n

KMS supports the EncryptionContextEquals and\n EncryptionContextSubset grant constraints. Each constraint value can include up\n to 8 encryption context pairs. The encryption context value in each constraint cannot exceed\n 384 characters. For information about grant constraints, see Using grant\n constraints in the Key Management Service Developer Guide. For more information about encryption context,\n see Encryption\n context in the \n Key Management Service Developer Guide\n .

\n

The encryption context grant constraints allow the permissions in the grant only when the\n encryption context in the request matches (EncryptionContextEquals) or includes\n (EncryptionContextSubset) the encryption context specified in this structure.

\n

The encryption context grant constraints are supported only on grant operations that\n include an EncryptionContext parameter, such as cryptographic operations on\n symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint\n doesn't apply to these operations. If a grant with a grant constraint includes the\n CreateGrant operation, the constraint requires that any grants created with the\n CreateGrant permission have an equally strict or stricter encryption context\n constraint.

\n

You cannot use an encryption context grant constraint for cryptographic operations with\n asymmetric KMS keys or HMAC KMS keys. These keys don't support an encryption context.

\n

" } }, "GrantTokens": { @@ -680,7 +683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a unique customer managed KMS key in your Amazon Web Services account and\n Region.

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n \n\n

You can use the CreateKey operation to create symmetric or asymmetric KMS\n keys.

\n \n

For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n\n\n

To create different types of KMS keys, use the following guidance:

\n\n
\n
Asymmetric KMS keys
\n
\n

To create an asymmetric KMS key, use the KeySpec parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.

\n

\n
\n
Symmetric KMS keys
\n
\n

When creating a symmetric KMS key, you don't need to specify the\n KeySpec or KeyUsage parameters. The default value for\n KeySpec, SYMMETRIC_DEFAULT, and the default value for\n KeyUsage, ENCRYPT_DECRYPT, are the only valid values for\n symmetric KMS keys.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

You can create symmetric and asymmetric multi-Region keys and multi-Region keys with\n imported key material. You cannot create multi-Region keys in a custom key store.

\n

\n
\n
\n

To import your own key material, begin by creating a symmetric KMS key with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric KMS key.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

To create a symmetric KMS key in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the Amazon Web Services Region.

\n

You cannot create an asymmetric KMS key in a custom key store. For information about\n custom key stores in KMS see Using Custom Key Stores in\n the \n Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n KMS keys in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Creates a unique customer managed KMS key in your Amazon Web Services account and\n Region.

\n

In addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type.

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n \n\n \n

To create different types of KMS keys, use the following guidance:

\n\n
\n
Symmetric encryption KMS key
\n
\n

To create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for\n KeySpec, SYMMETRIC_DEFAULT, and the default value for\n KeyUsage, ENCRYPT_DECRYPT, create a symmetric encryption KMS key.

\n

If you need a key for basic encryption and decryption or you \n are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.

\n

\n
\n
Asymmetric KMS keys
\n
\n

To create an asymmetric KMS key, use the KeySpec parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.

\n

Asymmetric KMS keys contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric \n KMS key never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key\n so it can be used outside of AWS KMS. KMS keys with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). \n KMS keys with ECC key pairs can be used only to sign and verify messages. \n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

\n
\n
HMAC KMS key
\n
\n

To create an HMAC KMS key, set the KeySpec parameter to a\n key spec value for HMAC KMS keys. Then set the KeyUsage parameter to\n GENERATE_VERIFY_MAC. You must set the key usage even though\n GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys.\n You can't change these properties after the KMS key is created.

\n

HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use\n HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.

\n

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC\n KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the\n CreateKey operation returns an\n UnsupportedOperationException. For a list of Regions in which HMAC KMS keys\n are supported, see HMAC keys in\n KMS in the Key Management Service Developer Guide.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

You can create multi-Region KMS keys for all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't create multi-Region keys in a custom key store.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
\n

To import your own key material, begin by creating a symmetric encryption KMS key with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n .

\n

This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key\n material into any other type of KMS key.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

To create a symmetric encryption KMS key in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the Amazon Web Services Region.

\n

Custom key stores support only symmetric encryption KMS keys. You cannot create an\n HMAC KMS key or an asymmetric KMS key in a custom key store. For information about\n custom key stores in KMS see Custom key stores in KMS in\n the \n Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n KMS keys in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateKeyRequest": { @@ -701,7 +704,7 @@ "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You\n can't change the KeyUsage value after the KMS key is created.

\n

Select only one valid value.

\n " + "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric\n encryption KMS key; otherwise, it is required. You\n can't change the KeyUsage value after the KMS key is created.

\n

Select only one valid value.

\n " } }, "CustomerMasterKeySpec": { @@ -716,19 +719,19 @@ "KeySpec": { "target": "com.amazonaws.kms#KeySpec", "traits": { - "smithy.api#documentation": "

Specifies the type of KMS key to create. The default value,\n SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption\n and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key\n Configuration in the \n Key Management Service Developer Guide\n .

\n

The KeySpec determines whether the KMS key contains a symmetric key or an\n asymmetric key pair. It also determines the encryption algorithms or signing algorithms that\n the KMS key supports. You can't change the KeySpec after the KMS key is created.\n To further restrict the algorithms that can be used with the KMS key, use a condition key in\n its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the \n Key Management Service Developer Guide\n .

\n \n

\n Amazon Web Services services that\n are integrated with KMS use symmetric KMS keys to protect your data. These\n services do not support asymmetric KMS keys. For help determining whether a KMS key is\n symmetric or asymmetric, see Identifying Symmetric and Asymmetric\n KMS keys in the Key Management Service Developer Guide.

\n \n

KMS supports the following key specs for KMS keys:

\n " + "smithy.api#documentation": "

Specifies the type of KMS key to create. The default value,\n SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption\n and decryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in\n the \n Key Management Service Developer Guide\n .

\n

The KeySpec determines whether the KMS key contains a symmetric key or an\n asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't\n change the KeySpec after the KMS key is created. To further restrict the\n algorithms that can be used with the KMS key, use a condition key in its key policy or IAM\n policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the \n Key Management Service Developer Guide\n .

\n \n

\n Amazon Web Services services that\n are integrated with KMS use symmetric encryption KMS keys to protect your data.\n These services do not support asymmetric KMS keys or HMAC KMS keys.

\n \n

KMS supports the following key specs for KMS keys:

\n " } }, "Origin": { "target": "com.amazonaws.kms#OriginType", "traits": { - "smithy.api#documentation": "

The source of the key material for the KMS key. You cannot change the origin after you\n create the KMS key. The default is AWS_KMS, which means that KMS creates the\n key material.

\n

To create a KMS key with no key material (for imported key material), set the value to\n EXTERNAL. For more information about importing key material into KMS, see\n Importing Key\n Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS\n keys.

\n

To create a KMS key in an KMS custom key store and create its key material in the\n associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the\n CustomKeyStoreId parameter to identify the custom key store. This value is\n valid only for symmetric KMS keys.

" + "smithy.api#documentation": "

The source of the key material for the KMS key. You cannot change the origin after you\n create the KMS key. The default is AWS_KMS, which means that KMS creates the\n key material.

\n

To create a KMS key with no key material (for imported key material), set the value to\n EXTERNAL. For more information about importing key material into KMS, see\n Importing Key\n Material in the Key Management Service Developer Guide. This value is valid only for symmetric encryption KMS keys.

\n

To create a KMS key in an KMS custom key store and create its key material in the\n associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the\n CustomKeyStoreId parameter to identify the custom key store. This value is\n valid only for symmetric encryption KMS keys.

" } }, "CustomKeyStoreId": { "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

Creates the KMS key in the specified custom key store and the key material in its\n associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric KMS keys and regional KMS keys. You cannot\n create an asymmetric KMS key or a multi-Region key in a custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

" + "smithy.api#documentation": "

Creates the KMS key in the specified custom key store and the key material in its\n associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric encryption KMS keys in a single Region. You \n cannot create any other type of KMS key in a custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

" } }, "BypassPolicyLockoutSafetyCheck": { @@ -740,13 +743,13 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is\n created. To tag an existing KMS key, use the TagResource operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" + "smithy.api#documentation": "

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is\n created. To tag an existing KMS key, use the TagResource operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" } }, "MultiRegion": { "target": "com.amazonaws.kms#NullableBooleanType", "traits": { - "smithy.api#documentation": "

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You\n cannot change this value after you create the KMS key.

\n

For a multi-Region key, set this parameter to True. For a single-Region KMS\n key, omit this parameter or set it to False. The default value is\n False.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

This value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.

\n

You can create a symmetric or asymmetric multi-Region key, and you can create a\n multi-Region key with imported key material. However, you cannot create a multi-Region key in\n a custom key store.

" + "smithy.api#documentation": "

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You\n cannot change this value after you create the KMS key.

\n

For a multi-Region key, set this parameter to True. For a single-Region KMS\n key, omit this parameter or set it to False. The default value is\n False.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

This value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.

\n

You can create a symmetric or asymmetric multi-Region key, and you can create a\n multi-Region key with imported key material. However, you cannot create a multi-Region key in\n a custom key store.

" } } } @@ -942,6 +945,22 @@ { "value": "SYMMETRIC_DEFAULT", "name": "SYMMETRIC_DEFAULT" + }, + { + "value": "HMAC_224", + "name": "HMAC_224" + }, + { + "value": "HMAC_256", + "name": "HMAC_256" + }, + { + "value": "HMAC_384", + "name": "HMAC_384" + }, + { + "value": "HMAC_512", + "name": "HMAC_512" } ] } @@ -1040,7 +1059,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the\n encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the\n public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by\n other libraries, such as the Amazon Web Services\n Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.

\n

If the ciphertext was encrypted under a symmetric KMS key, the KeyId\n parameter is optional. KMS can get this information from metadata that it adds to the\n symmetric ciphertext blob. This feature adds durability to your implementation by ensuring\n that authorized users can decrypt ciphertext decades after it was encrypted, even if they've\n lost track of the key ID. However, specifying the KMS key is always recommended as a best\n practice. When you use the KeyId parameter to specify a KMS key, KMS only uses\n the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the\n Decrypt operation fails. This practice ensures that you use the KMS key that\n you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an\n asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the\n encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the\n public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by\n other libraries, such as the Amazon Web Services\n Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.

\n

If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId\n parameter is optional. KMS can get this information from metadata that it adds to the\n symmetric ciphertext blob. This feature adds durability to your implementation by ensuring\n that authorized users can decrypt ciphertext decades after it was encrypted, even if they've\n lost track of the key ID. However, specifying the KMS key is always recommended as a best\n practice. When you use the KeyId parameter to specify a KMS key, KMS only uses\n the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the\n Decrypt operation fails. This practice ensures that you use the KMS key that\n you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DecryptRequest": { @@ -1056,7 +1075,7 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "GrantTokens": { @@ -1068,13 +1087,13 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a key ID of the KMS\n key that was used to encrypt the ciphertext.

\n\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the KMS key that KMS uses to decrypt the ciphertext.

\n \n

Enter a key ID of the KMS\n key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

\n\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "EncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify\n the same algorithm that was used to encrypt the data. If you specify a different algorithm,\n the Decrypt operation fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. The default value, SYMMETRIC_DEFAULT, represents the only supported\n algorithm that is valid for symmetric KMS keys.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify\n the same algorithm that was used to encrypt the data. If you specify a different algorithm,\n the Decrypt operation fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. The default value, SYMMETRIC_DEFAULT, represents the only supported\n algorithm that is valid for symmetric encryption KMS keys.

" } } } @@ -1107,6 +1126,9 @@ "input": { "target": "com.amazonaws.kms#DeleteAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1122,7 +1144,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alias.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Because an alias is not a property of a KMS key, you can delete and change the aliases of\n a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the\n DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

\n

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes the specified alias.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Because an alias is not a property of a KMS key, you can delete and change the aliases of\n a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the\n DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

\n

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteAliasRequest": { @@ -1184,6 +1206,9 @@ "input": { "target": "com.amazonaws.kms#DeleteImportedKeyMaterialRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1205,7 +1230,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified KMS\n key unusable. For more information about importing key material into KMS, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

When the specified KMS key is in the PendingDeletion state, this operation\n does not change the KMS key's state. Otherwise, it changes the KMS key's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the KMS key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified KMS\n key unusable. For more information about importing key material into KMS, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

When the specified KMS key is in the PendingDeletion state, this operation\n does not change the KMS key's state. Otherwise, it changes the KMS key's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the KMS key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteImportedKeyMaterialRequest": { @@ -1335,7 +1360,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish symmetric from\n asymmetric KMS keys. It also provides information that is particularly important to asymmetric\n keys, such as the key usage (encryption or signing) and the encryption algorithms or signing\n algorithms that the KMS key supports. For KMS keys in custom key stores, it includes\n information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For\n multi-Region keys, it displays the primary key and all related replica keys.

\n

\n DescribeKey does not return the following information:

\n \n

If you call the DescribeKey operation on a predefined Amazon Web Services\n alias, that is, an Amazon Web Services alias with no key ID, KMS creates an Amazon Web Services managed\n key. Then, it associates the alias with the new KMS key, and returns the\n KeyId and Arn of the new KMS key in the response.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish different types of KMS keys. It also displays the key usage (encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key supports. For KMS keys in custom key stores, it includes\n information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For\n multi-Region keys, it displays the primary key and all related replica keys.

\n

\n DescribeKey does not return the following information:

\n \n

In general, DescribeKey is a non-mutating operation. It returns data about\n KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to\n create Amazon Web Services\n managed keys from a predefined Amazon Web Services alias with no key\n ID.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeKeyRequest": { @@ -1381,6 +1406,9 @@ "input": { "target": "com.amazonaws.kms#DisableKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1399,7 +1427,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS\n key for cryptographic operations.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the \n Key Management Service Developer Guide\n .

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" + "smithy.api#documentation": "

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS\n key for cryptographic operations.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the \n Key Management Service Developer Guide\n .

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" } }, "com.amazonaws.kms#DisableKeyRequest": { @@ -1419,6 +1447,9 @@ "input": { "target": "com.amazonaws.kms#DisableKeyRotationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1443,7 +1474,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables automatic\n rotation of the key material for the specified symmetric KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Disables automatic\n rotation of the key material for the specified symmetric encryption KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DisableKeyRotationRequest": { @@ -1452,7 +1483,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric KMS key. You cannot enable or disable automatic rotation of asymmetric\n KMS keys, KMS keys with imported key material, or KMS keys in a\n custom key store.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric\n KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a\n custom key store.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1519,6 +1550,9 @@ "input": { "target": "com.amazonaws.kms#EnableKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1540,7 +1574,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for\n cryptographic operations.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" + "smithy.api#documentation": "

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for\n cryptographic operations.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" } }, "com.amazonaws.kms#EnableKeyRequest": { @@ -1560,6 +1594,9 @@ "input": { "target": "com.amazonaws.kms#EnableKeyRotationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1584,7 +1621,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables automatic rotation\n of the key material for the specified symmetric KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Enables automatic rotation\n of the key material for the specified symmetric encryption KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EnableKeyRotationRequest": { @@ -1593,7 +1630,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric KMS key. You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1634,7 +1671,7 @@ } ], "traits": { - "smithy.api#documentation": "

Encrypts plaintext into ciphertext by using a KMS key. The Encrypt operation\n has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the\n encryption operation. The KMS key must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

\n\n

If you use a symmetric KMS key, you can use an encryption context to add additional\n security to your encryption operation. If you specify an EncryptionContext when\n encrypting data, you must specify the same encryption context (a case-sensitive exact match)\n when decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the Key Management Service Developer Guide.

\n

If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The\n algorithm must be compatible with the KMS key type.

\n \n

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of KMS key and the\n encryption algorithm that you choose.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or\n asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT.

\n

You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or\n database password, or other sensitive information. You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

If you use a symmetric encryption KMS key, you can use an encryption context to add additional\n security to your encryption operation. If you specify an EncryptionContext when\n encrypting data, you must specify the same encryption context (a case-sensitive exact match)\n when decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the Key Management Service Developer Guide.

\n

If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The\n algorithm must be compatible with the KMS key type.

\n \n

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of KMS key and the\n encryption algorithm that you choose.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EncryptRequest": { @@ -1643,7 +1680,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the KMS key to use in the encryption operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Identifies the KMS key to use in the encryption operation. The KMS key must have a\n KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of\n a KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1657,7 +1694,7 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "GrantTokens": { @@ -1669,7 +1706,7 @@ "EncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the KMS key that you specify.

\n

This parameter is required only for asymmetric KMS keys. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric KMS keys. If you are\n using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the KMS key that you specify.

\n

This parameter is required only for asymmetric KMS keys. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are\n using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

" } } } @@ -1807,7 +1844,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a KMS key that you specify.\n You can use the plaintext key to encrypt your data outside of KMS and store the encrypted\n data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the KMS key.

\n\n

To generate a data key, specify the symmetric KMS key that will be used to encrypt the\n data key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your\n KMS key, use the DescribeKey operation. You must also specify the length of\n the data key. Use either the KeySpec or NumberOfBytes parameters\n (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n How to use your data\n key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns a unique symmetric data key for use outside of KMS. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS\n key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS\n key. You can use the plaintext key to encrypt your data outside of KMS and store the\n encrypted data key with the encrypted data.

\n\n

To generate a data key, specify the symmetric encryption KMS key that will be used to\n encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the\n type of your KMS key, use the DescribeKey operation. You must also specify\n the length of the data key. Use either the KeySpec or NumberOfBytes\n parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec\n parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n How to use your data\n key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPair": { @@ -1848,7 +1885,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric KMS key you specify. You can use the data key pair\n to perform asymmetric cryptography and implement digital signatures outside of KMS.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric KMS key to encrypt the private\n key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key\n store. To get the type and origin of your KMS key, use the DescribeKey\n operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the KMS key that is used to encrypt the\n private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280. The private key is a\n DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key, a plaintext private key, and a copy of the private key that is\n encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to\n perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes\n in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the\n private key.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the\n private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280. The private key is a\n DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairRequest": { @@ -1857,13 +1894,13 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the symmetric KMS key that encrypts the private key in the data key pair. You\n cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and\n origin of your KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Specifies the symmetric encryption KMS key that encrypts the private key in the data key\n pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the\n type and origin of your KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1900,7 +1937,7 @@ "PublicKey": { "target": "com.amazonaws.kms#PublicKeyType", "traits": { - "smithy.api#documentation": "

The public key (in plaintext).

" + "smithy.api#documentation": "

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "KeyId": { @@ -1955,7 +1992,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric KMS key you specify.\n Unlike GenerateDataKeyPair, this operation does not return a plaintext\n private key.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

To generate a data key pair, you must specify a symmetric KMS key to encrypt the private\n key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key\n store. To get the type and origin of your KMS key, use the DescribeKey\n operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or KMS key that is used to encrypt\n the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key and a copy of the private key that is encrypted under the symmetric\n encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation\n does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller\n or to the KMS key that is used to encrypt the private key.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or KMS key that is used to encrypt\n the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairWithoutPlaintextRequest": { @@ -1964,13 +2001,13 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the KMS key that encrypts the private key in the data key pair. You must specify\n a symmetric KMS key. You cannot use an asymmetric KMS key or a KMS key in a custom key store.\n To get the type and origin of your KMS key, use the DescribeKey operation.\n

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Specifies the symmetric encryption KMS key that encrypts the private key in the data key\n pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the\n type and origin of your KMS key, use the DescribeKey operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -2001,7 +2038,7 @@ "PublicKey": { "target": "com.amazonaws.kms#PublicKeyType", "traits": { - "smithy.api#documentation": "

The public key (in plaintext).

" + "smithy.api#documentation": "

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "KeyId": { @@ -2024,14 +2061,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the symmetric KMS key that encrypts the data key.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify\n an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your\n KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "NumberOfBytes": { @@ -2112,7 +2149,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a KMS key that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext\n operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or KMS key that is used to encrypt the\n private key.

\n\n

To generate a data key, you must specify the symmetric KMS key that is used to encrypt the\n data key. You cannot use an asymmetric KMS key to generate a data key. To get the type of your\n KMS key, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns a unique symmetric data key for use outside of KMS. This operation returns a\n data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in\n the key are random; they are not related to the caller or to the KMS key.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the\n data key.

\n

This operation is useful for systems that need to encrypt data at some point, but not\n immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key. It's also useful in distributed systems with\n different levels of trust. For example, you might store encrypted data in containers. One\n component of your system creates new containers and stores an encrypted data key with each\n container. Then, a different component puts the data into the containers. That component first\n decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data\n into the container, and then destroys the plaintext data key. In this system, the component\n that creates the containers never sees the plaintext data key.

\n

To request an asymmetric data key pair, use the GenerateDataKeyPair or\n GenerateDataKeyPairWithoutPlaintext operations.

\n\n

To generate a data key, you must specify the symmetric encryption KMS key that is used to\n encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the\n type of your KMS key, use the DescribeKey operation.

\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyWithoutPlaintextRequest": { @@ -2121,14 +2158,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric KMS key that encrypts the data key.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify\n an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your\n KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "KeySpec": { @@ -2168,6 +2205,96 @@ } } }, + "com.amazonaws.kms#GenerateMac": { + "type": "operation", + "input": { + "target": "com.amazonaws.kms#GenerateMacRequest" + }, + "output": { + "target": "com.amazonaws.kms#GenerateMacResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kms#DisabledException" + }, + { + "target": "com.amazonaws.kms#InvalidGrantTokenException" + }, + { + "target": "com.amazonaws.kms#InvalidKeyUsageException" + }, + { + "target": "com.amazonaws.kms#KeyUnavailableException" + }, + { + "target": "com.amazonaws.kms#KMSInternalException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.kms#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS\n key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the\n message and the key as described in RFC 2104.

\n

You can use the HMAC that this operation generates with the VerifyMac\n operation to demonstrate that the original message has not changed. Also, because a secret key\n is used to create the hash, you can verify that the party that generated the hash has the\n required secret key. This operation is part of KMS support for HMAC KMS keys.\n For details, see HMAC keys in KMS in the \n Key Management Service Developer Guide\n .

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:GenerateMac (key policy)

\n

\n Related operations: VerifyMac\n

" + } + }, + "com.amazonaws.kms#GenerateMacRequest": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kms#PlaintextType", + "traits": { + "smithy.api#documentation": "

The message to be hashed. Specify a message of up to 4,096 bytes.

\n

\n GenerateMac and VerifyMac do not provide special handling\n for message digests. If you generate an HMAC for a hash digest of a message, you must verify\n the HMAC of the same hash digest.

", + "smithy.api#required": {} + } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

\n

To identify an HMAC KMS key, use the DescribeKey operation and see the\n KeySpec field in the response.

", + "smithy.api#required": {} + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm used in the operation.

\n

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC\n algorithms that your HMAC KMS key supports, use the DescribeKey operation\n and see the MacAlgorithms field in the DescribeKey response.

", + "smithy.api#required": {} + } + }, + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", + "traits": { + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" + } + } + } + }, + "com.amazonaws.kms#GenerateMacResponse": { + "type": "structure", + "members": { + "Mac": { + "target": "com.amazonaws.kms#CiphertextType", + "traits": { + "smithy.api#documentation": "

The hash-based message authentication code (HMAC) for the given message, key, and MAC\n algorithm.

" + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm that was used to generate the HMAC.

" + } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The HMAC KMS key used in the operation.

" + } + } + } + }, "com.amazonaws.kms#GenerateRandom": { "type": "operation", "input": { @@ -2310,7 +2437,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these KMS keys is always\n false.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these KMS keys is always\n false.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetKeyRotationStatusRequest": { @@ -2365,7 +2492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the items you need to import key material into a symmetric, customer managed KMS\n key. For more information about importing key material into KMS, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric KMS key into which you will import key\n material. This KMS key's Origin must be EXTERNAL. You must also\n specify the wrapping algorithm and type of wrapping key (public key) that you will use to\n encrypt the key material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns the items you need to import key material into a symmetric encryption KMS key. For\n more information about importing key material into KMS, see Importing key material in the\n Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric encryption KMS key into which you will import\n key material. This KMS key's Origin must be EXTERNAL. You must also\n specify the wrapping algorithm and type of wrapping key (public key) that you will use to\n encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetParametersForImportRequest": { @@ -2374,7 +2501,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric KMS key into which you will import key material. The\n Origin of the KMS key must be EXTERNAL.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

The identifier of the symmetric encryption KMS key into which you will import key material. The\n Origin of the KMS key must be EXTERNAL.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -2464,7 +2591,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric\n KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey\n permission can download the public key of an asymmetric KMS key. You can share the public key\n to allow others to encrypt messages and verify signatures outside of KMS.\n For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the\n public key within KMS, you benefit from the authentication, authorization, and logging that\n are part of every KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of KMS. For details, see Special\n Considerations for Downloading Public Keys.

\n

To help you use the public key safely outside of KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use:\n Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" + "smithy.api#documentation": "

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric\n KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey\n permission can download the public key of an asymmetric KMS key. You can share the public key\n to allow others to encrypt messages and verify signatures outside of KMS.\n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the\n public key within KMS, you benefit from the authentication, authorization, and logging that\n are part of every KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of KMS. For details, see Special\n Considerations for Downloading Public Keys.

\n

To help you use the public key safely outside of KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use:\n Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" } }, "com.amazonaws.kms#GetPublicKeyRequest": { @@ -2552,7 +2679,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n Key Management Service Developer Guide\n .

\n " + "smithy.api#documentation": "

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric encryption KMS key. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with HMAC KMS keys or asymmetric KMS keys, and management operations, such as DescribeKey or RetireGrant.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n Key Management Service Developer Guide\n .

\n " } }, "com.amazonaws.kms#GrantIdType": { @@ -2701,6 +2828,14 @@ { "value": "GenerateDataKeyPairWithoutPlaintext", "name": "GenerateDataKeyPairWithoutPlaintext" + }, + { + "value": "GenerateMac", + "name": "GenerateMac" + }, + { + "value": "VerifyMac", + "name": "VerifyMac" } ] } @@ -2773,7 +2908,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports key material into an existing symmetric KMS KMS key that was created without key\n material. After you successfully import key material into a KMS key, you can reimport\n the same key material into that KMS key, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material\n and then importing key material, see Importing Key Material in the\n Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the KMS key changes from\n PendingImport to Enabled, and you can use the KMS key.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key\n and repeat the import procedure. For help, see How To Import Key\n Material in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Imports key material into an existing symmetric encryption KMS key that was created\n without key material. After you successfully import key material into a KMS key, you can\n reimport the same key material into that KMS key, but you cannot import different\n key material.

\n

You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about\n creating KMS keys with no key material and then importing key material, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the KMS key changes from\n PendingImport to Enabled, and you can use the KMS key.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key\n and repeat the import procedure. For help, see How To Import Key\n Material in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ImportKeyMaterialRequest": { @@ -2782,7 +2917,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric KMS key that receives the imported key material. The KMS\n key's Origin must be EXTERNAL. This must be the same KMS key\n specified in the KeyID parameter of the corresponding GetParametersForImport request.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

The identifier of the symmetric encryption KMS key that receives the imported key\n material. This must be the same KMS key specified in the KeyID parameter of the\n corresponding GetParametersForImport request. The Origin of the\n KMS key must be EXTERNAL. You cannot perform this operation on an asymmetric KMS\n key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different\n Amazon Web Services account

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -2830,7 +2965,7 @@ "code": "IncorrectKeyException", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The request was rejected because the specified KMS key cannot decrypt the data. The\n KeyId in a Decrypt request and the SourceKeyId\n in a ReEncrypt request must identify the same KMS key that was used to\n encrypt the ciphertext.

", + "smithy.api#documentation": "

The request was rejected because the specified KMS key cannot decrypt the data. The\n KeyId in a Decrypt request and the SourceKeyId\n in a ReEncrypt request must identify the same KMS key that was used to\n encrypt the ciphertext.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2983,7 +3118,7 @@ "code": "InvalidKeyUsage", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The request was rejected for one of the following reasons:

\n \n

For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the\n KeyUsage must be SIGN_VERIFY. To find the KeyUsage of\n a KMS key, use the DescribeKey operation.

\n

To find the encryption or signing algorithms supported for a particular KMS key, use the\n DescribeKey operation.

", + "smithy.api#documentation": "

The request was rejected for one of the following reasons:

\n \n

For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying\n messages, the KeyUsage must be SIGN_VERIFY. For generating and\n verifying message authentication codes (MACs), the KeyUsage must be\n GENERATE_VERIFY_MAC. To find the KeyUsage of a KMS key, use the\n DescribeKey operation.

\n

To find the encryption or signing algorithms supported for a particular KMS key, use the\n DescribeKey operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3022,6 +3157,23 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.kms#KMSInvalidMacException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.kms#ErrorMessageType" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSInvalidMac", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the HMAC verification failed. HMAC verification\n fails when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does not match the HMAC specified in the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.kms#KMSInvalidSignatureException": { "type": "structure", "members": { @@ -3051,7 +3203,7 @@ "code": "KMSInvalidStateException", "httpResponseCode": 409 }, - "smithy.api#documentation": "

The request was rejected because the state of the specified resource is not valid for this\n request.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the \n Key Management Service Developer Guide\n .

", + "smithy.api#documentation": "

The request was rejected because the state of the specified resource is not valid for this\n request.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the \n Key Management Service Developer Guide\n .

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -3155,7 +3307,7 @@ "KeyState": { "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

" } }, "DeletionDate": { @@ -3230,7 +3382,7 @@ "MultiRegion": { "target": "com.amazonaws.kms#NullableBooleanType", "traits": { - "smithy.api#documentation": "

Indicates whether the KMS key is a multi-Region (True) or regional\n (False) key. This value is True for multi-Region primary and\n replica keys and False for regional KMS keys.

\n

For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Indicates whether the KMS key is a multi-Region (True) or regional\n (False) key. This value is True for multi-Region primary and\n replica keys and False for regional KMS keys.

\n

For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

" } }, "MultiRegionConfiguration": { @@ -3244,6 +3396,12 @@ "traits": { "smithy.api#documentation": "

The waiting period before the primary key in a multi-Region key is deleted. This waiting\n period begins when the last of its replica keys is deleted. This value is present only when\n the KeyState of the KMS key is PendingReplicaDeletion. That\n indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for\n deletion, and it still has existing replica keys.

\n

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its\n deletion date is displayed in the DeletionDate field. However, when the primary\n key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until\n all of its replica keys are deleted. This value displays that waiting period. When the last\n replica key in the multi-Region key is deleted, the KeyState of the scheduled\n primary key changes from PendingReplicaDeletion to PendingDeletion\n and the deletion date appears in the DeletionDate field.

" } + }, + "MacAlgorithms": { + "target": "com.amazonaws.kms#MacAlgorithmSpecList", + "traits": { + "smithy.api#documentation": "

The message authentication code (MAC) algorithm that the HMAC KMS key supports.

\n

This value is present only when the KeyUsage of the KMS key is\n GENERATE_VERIFY_MAC.

" + } } }, "traits": { @@ -3285,6 +3443,22 @@ { "value": "SYMMETRIC_DEFAULT", "name": "SYMMETRIC_DEFAULT" + }, + { + "value": "HMAC_224", + "name": "HMAC_224" + }, + { + "value": "HMAC_256", + "name": "HMAC_256" + }, + { + "value": "HMAC_384", + "name": "HMAC_384" + }, + { + "value": "HMAC_512", + "name": "HMAC_512" } ] } @@ -3366,6 +3540,10 @@ { "value": "ENCRYPT_DECRYPT", "name": "ENCRYPT_DECRYPT" + }, + { + "value": "GENERATE_VERIFY_MAC", + "name": "GENERATE_VERIFY_MAC" } ] } @@ -3510,7 +3688,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all grants for the specified KMS key.

\n

You must specify the KMS key in all requests. You can filter the grant list by grant ID or\n grantee principal.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:ListGrants (key policy)

\n

\n Related operations:\n

\n ", + "smithy.api#documentation": "

Gets a list of all grants for the specified KMS key.

\n

You must specify the KMS key in all requests. You can filter the grant list by grant ID or\n grantee principal.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:ListGrants (key policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3785,7 +3963,7 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n " + "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n " } }, "NextMarker": { @@ -3828,7 +4006,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about all grants in the Amazon Web Services account and Region that have the\n specified retiring principal.

\n

You can specify any principal in your Amazon Web Services account. The grants that are returned include\n grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this\n operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: You must specify a principal in your\n Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n Amazon Web Services account other than your own.

\n\n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your\n Amazon Web Services account.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns information about all grants in the Amazon Web Services account and Region that have the\n specified retiring principal.

\n

You can specify any principal in your Amazon Web Services account. The grants that are returned include\n grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this\n operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: You must specify a principal in your\n Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n Amazon Web Services account other than your own.

\n\n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your\n Amazon Web Services account.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListRetirableGrantsRequest": { @@ -3855,6 +4033,35 @@ } } }, + "com.amazonaws.kms#MacAlgorithmSpec": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HMAC_SHA_224", + "name": "HMAC_SHA_224" + }, + { + "value": "HMAC_SHA_256", + "name": "HMAC_SHA_256" + }, + { + "value": "HMAC_SHA_384", + "name": "HMAC_SHA_384" + }, + { + "value": "HMAC_SHA_512", + "name": "HMAC_SHA_512" + } + ] + } + }, + "com.amazonaws.kms#MacAlgorithmSpecList": { + "type": "list", + "member": { + "target": "com.amazonaws.kms#MacAlgorithmSpec" + } + }, "com.amazonaws.kms#MalformedPolicyDocumentException": { "type": "structure", "members": { @@ -4086,6 +4293,9 @@ "input": { "target": "com.amazonaws.kms#PutKeyPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -4189,7 +4399,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this\n operation to change the KMS key under which data is encrypted, such as when you manually\n rotate a KMS key or change the KMS key that protects a ciphertext. You can also use\n it to reencrypt ciphertext under the same KMS key, such as to change the encryption\n context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n KMS KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric KMS key\n outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as\n the Amazon Web Services Encryption SDK or\n Amazon S3\n client-side encryption. These libraries return a ciphertext format that is\n incompatible with KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both\n KMS keys can be in a different account than the caller. To specify a KMS key in a different\n account, you must use its key ARN or alias ARN.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a KMS key, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a KMS key. But you\n must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this\n operation to change the KMS key under which data is encrypted, such as when you manually\n rotate a KMS key or change the KMS key that protects a ciphertext. You can also use\n it to reencrypt ciphertext under the same KMS key, such as to change the encryption\n context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using a\n KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric KMS key\n outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as\n the Amazon Web Services Encryption SDK or\n Amazon S3\n client-side encryption. These libraries return a ciphertext format that is\n incompatible with KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both\n KMS keys can be in a different account than the caller. To specify a KMS key in a different\n account, you must use its key ARN or alias ARN.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a KMS key, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a KMS key. But you\n must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ReEncryptRequest": { @@ -4205,38 +4415,38 @@ "SourceEncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context to use to decrypt the ciphertext. Enter the same\n encryption context that was used to encrypt the ciphertext.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context to use to decrypt the ciphertext. Enter the same\n encryption context that was used to encrypt the ciphertext.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "SourceKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is\n re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is\n re-encrypted.

\n

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt operation throws an IncorrectKeyException.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that\n it adds to the symmetric ciphertext blob. However, it is always recommended as a best\n practice. This practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "DestinationKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the KMS key that is used to reencrypt the data. Specify a\n symmetric or asymmetric KMS key with a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the\n DescribeKey operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

A unique identifier for the KMS key that is used to reencrypt the data. Specify a\n symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the\n DescribeKey operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "DestinationEncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination KMS key is a symmetric\n KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "SourceEncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it\n is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm\n used for symmetric KMS keys.

\n

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a\n different algorithm, the decrypt attempt fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it\n is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm\n used for symmetric encryption KMS keys.

\n

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a\n different algorithm, the decrypt attempt fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key.

" } }, "DestinationEncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has\n decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption\n algorithm used for symmetric KMS keys.

\n

This parameter is required only when the destination KMS key is an asymmetric KMS\n key.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has\n decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption\n algorithm used for symmetric encryption KMS keys.

\n

This parameter is required only when the destination KMS key is an asymmetric KMS\n key.

" } }, "GrantTokens": { @@ -4333,7 +4543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Replicates a multi-Region key into the specified Region. This operation creates a\n multi-Region replica key based on a multi-Region primary key in a different Region of the same\n Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a\n different Region. To create a multi-Region primary key, use the CreateKey\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

A replica key is a fully-functional KMS key that can be used\n independently of its primary and peer replica keys. A primary key and its replica keys share\n properties that make them interoperable. They have the same key ID and key material. They also\n have the same key\n spec, key\n usage, key\n material origin, and automatic key rotation status. KMS automatically synchronizes these shared\n properties among related multi-Region keys. All other properties of a replica key can differ,\n including its key\n policy, tags, aliases, and key\n state. KMS pricing and quotas for KMS keys apply to each primary key and replica\n key.

\n

When this operation completes, the new replica key has a transient key state of\n Creating. This key state changes to Enabled (or\n PendingImport) after a few seconds when the process of creating the new replica\n key is complete. While the key state is Creating, you can manage key, but you\n cannot yet use it in cryptographic operations. If you are creating and using the replica key\n programmatically, retry on KMSInvalidStateException or call\n DescribeKey to check its KeyState value before using it. For\n details about the Creating key state, see Key state: Effect on your KMS key in the\n Key Management Service Developer Guide.

\n

The CloudTrail log of a ReplicateKey operation records a\n ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

\n

If you replicate a multi-Region primary key with imported key material, the replica key is\n created with no key material. You must import the same key material that you imported into the\n primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.

\n

To convert a replica key to a primary key, use the UpdatePrimaryRegion\n operation.

\n \n

\n ReplicateKey uses different default values for the KeyPolicy\n and Tags parameters than those used in the KMS console. For details, see the\n parameter descriptions.

\n \n

\n Cross-account use: No. You cannot use this operation to\n create a replica key in a different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " + "smithy.api#documentation": "

Replicates a multi-Region key into the specified Region. This operation creates a\n multi-Region replica key based on a multi-Region primary key in a different Region of the same\n Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a\n different Region. To create a multi-Region primary key, use the CreateKey\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

A replica key is a fully-functional KMS key that can be used\n independently of its primary and peer replica keys. A primary key and its replica keys share\n properties that make them interoperable. They have the same key ID and key material. They also\n have the same key\n spec, key\n usage, key\n material origin, and automatic key rotation status. KMS automatically synchronizes these shared\n properties among related multi-Region keys. All other properties of a replica key can differ,\n including its key\n policy, tags, aliases, and Key states of KMS keys. KMS pricing and quotas for KMS keys apply to each primary key and replica\n key.

\n

When this operation completes, the new replica key has a transient key state of\n Creating. This key state changes to Enabled (or\n PendingImport) after a few seconds when the process of creating the new replica\n key is complete. While the key state is Creating, you can manage key, but you\n cannot yet use it in cryptographic operations. If you are creating and using the replica key\n programmatically, retry on KMSInvalidStateException or call\n DescribeKey to check its KeyState value before using it. For\n details about the Creating key state, see Key states of KMS keys in the\n Key Management Service Developer Guide.

\n

You cannot create more than one replica of a primary key in any Region. If the Region\n already includes a replica of the key you're trying to replicate, ReplicateKey\n returns an AlreadyExistsException error. If the key state of the existing replica\n is PendingDeletion, you can cancel the scheduled key deletion (CancelKeyDeletion) or wait for the key to be deleted. The new replica key you create\n will have the same shared properties as the original replica key.

\n

The CloudTrail log of a ReplicateKey operation records a\n ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

\n

If you replicate a multi-Region primary key with imported key material, the replica key is\n created with no key material. You must import the same key material that you imported into the\n primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.

\n

To convert a replica key to a primary key, use the UpdatePrimaryRegion\n operation.

\n \n

\n ReplicateKey uses different default values for the KeyPolicy\n and Tags parameters than those used in the KMS console. For details, see the\n parameter descriptions.

\n \n

\n Cross-account use: No. You cannot use this operation to\n create a replica key in a different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ReplicateKeyRequest": { @@ -4349,7 +4559,7 @@ "ReplicaRegion": { "target": "com.amazonaws.kms#RegionType", "traits": { - "smithy.api#documentation": "

The Region ID of the Amazon Web Services Region for this replica key.

\n

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a\n list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the\n Amazon Web Services General Reference.

\n

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of\n that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica\n Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the\n Region.

\n

For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the\n Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a\n Region and Disabling a Region in the\n Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The Region ID of the Amazon Web Services Region for this replica key.

\n

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a\n list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the\n Amazon Web Services General Reference.

\n \n

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC\n KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the\n ReplicateKey operation returns an UnsupportedOperationException.\n For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.

\n \n

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of\n that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica\n Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the\n Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the\n Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a\n Region and Disabling a Region in the\n Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -4374,7 +4584,7 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it\n is created. To tag an existing KMS key, use the TagResource\n operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Tags are not a shared property of multi-Region keys. You can specify the same tags or\n different tags for each key in a set of related multi-Region keys. KMS does not synchronize\n this property.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" + "smithy.api#documentation": "

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it\n is created. To tag an existing KMS key, use the TagResource\n operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Tags are not a shared property of multi-Region keys. You can specify the same tags or\n different tags for each key in a set of related multi-Region keys. KMS does not synchronize\n this property.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" } } } @@ -4385,7 +4595,7 @@ "ReplicaKeyMetadata": { "target": "com.amazonaws.kms#KeyMetadata", "traits": { - "smithy.api#documentation": "

Displays details about the new replica key, including its Amazon Resource Name (key ARN) and\n key state. It also\n includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

" + "smithy.api#documentation": "

Displays details about the new replica key, including its Amazon Resource Name (key ARN) and\n Key states of KMS keys. It also\n includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

" } }, "ReplicaPolicy": { @@ -4407,6 +4617,9 @@ "input": { "target": "com.amazonaws.kms#RetireGrantRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -4431,7 +4644,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To\n identify the grant to retire, use a grant token, or both the grant ID and a\n key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation\n returns both values.

\n

This operation can be called by the retiring principal for a grant,\n by the grantee principal if the grant allows the RetireGrant\n operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be\n called by principals to whom permission for retiring a grant is delegated. For details, see\n Retiring and\n revoking grants in the Key Management Service Developer Guide.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. You can retire a grant on a KMS\n key in a different Amazon Web Services account.

\n

\n Required permissions::Permission to retire a grant is\n determined primarily by the grant. For details, see Retiring and revoking grants in\n the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To\n identify the grant to retire, use a grant token, or both the grant ID and a\n key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation\n returns both values.

\n

This operation can be called by the retiring principal for a grant,\n by the grantee principal if the grant allows the RetireGrant\n operation, and by the Amazon Web Services account in which the grant is created. It can also be called by\n principals to whom permission for retiring a grant is delegated. For details, see Retiring and revoking\n grants in the Key Management Service Developer Guide.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. You can retire a grant on a KMS\n key in a different Amazon Web Services account.

\n

\n Required permissions::Permission to retire a grant is\n determined primarily by the grant. For details, see Retiring and revoking grants in\n the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RetireGrantRequest": { @@ -4462,6 +4675,9 @@ "input": { "target": "com.amazonaws.kms#RevokeGrantRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -4483,7 +4699,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified grant. You revoke a grant to terminate the permissions that the\n grant allows. For more information, see Retiring and revoking grants in\n the \n Key Management Service Developer Guide\n .

\n

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in\n the \n Key Management Service Developer Guide\n .

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:RevokeGrant (key policy).

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes the specified grant. You revoke a grant to terminate the permissions that the\n grant allows. For more information, see Retiring and revoking grants in\n the \n Key Management Service Developer Guide\n .

\n

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in\n the \n Key Management Service Developer Guide\n .

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:RevokeGrant (key policy).

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RevokeGrantRequest": { @@ -4531,7 +4747,7 @@ } ], "traits": { - "smithy.api#documentation": "

Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30\n days, but you can specify a waiting period of 7-30 days. When this operation is successful,\n the key state of the KMS key changes to PendingDeletion and the key can't be used\n in any cryptographic operations. It remains in this state for the duration of the waiting\n period. Before the waiting period ends, you can use CancelKeyDeletion to\n cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,\n its key material, and all KMS data associated with it, including all aliases that refer to\n it.

\n \n

Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key\n is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only\n exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting\n it, use DisableKey.

\n \n

If you schedule deletion of a KMS key from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the KMS key from KMS. Then KMS makes a\n best effort to delete the key material from the associated CloudHSM cluster. However, you might\n need to manually delete the orphaned key\n material from the cluster and its backups.

\n

You can schedule the deletion of a multi-Region primary key and its replica keys at any\n time. However, KMS will not delete a multi-Region primary key with existing replica keys. If\n you schedule the deletion of a primary key with replicas, its key state changes to\n PendingReplicaDeletion and it cannot be replicated or used in cryptographic\n operations. This status can continue indefinitely. When the last of its replicas keys is\n deleted (not just scheduled), the key state of the primary key changes to\n PendingDeletion and its waiting period (PendingWindowInDays)\n begins. For details, see Deleting multi-Region keys in the\n Key Management Service Developer Guide.

\n

For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n\n

\n Required permissions: kms:ScheduleKeyDeletion (key\n policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30\n days, but you can specify a waiting period of 7-30 days. When this operation is successful,\n the key state of the KMS key changes to PendingDeletion and the key can't be used\n in any cryptographic operations. It remains in this state for the duration of the waiting\n period. Before the waiting period ends, you can use CancelKeyDeletion to\n cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,\n its key material, and all KMS data associated with it, including all aliases that refer to\n it.

\n \n

Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key\n is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only\n exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting\n it, use DisableKey.

\n \n

If you schedule deletion of a KMS key from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the KMS key from KMS. Then KMS makes a\n best effort to delete the key material from the associated CloudHSM cluster. However, you might\n need to manually delete the orphaned key\n material from the cluster and its backups.

\n

You can schedule the deletion of a multi-Region primary key and its replica keys at any\n time. However, KMS will not delete a multi-Region primary key with existing replica keys. If\n you schedule the deletion of a primary key with replicas, its key state changes to\n PendingReplicaDeletion and it cannot be replicated or used in cryptographic\n operations. This status can continue indefinitely. When the last of its replicas keys is\n deleted (not just scheduled), the key state of the primary key changes to\n PendingDeletion and its waiting period (PendingWindowInDays)\n begins. For details, see Deleting multi-Region keys in the\n Key Management Service Developer Guide.

\n

For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n\n

\n Required permissions: kms:ScheduleKeyDeletion (key\n policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ScheduleKeyDeletionRequest": { @@ -4570,7 +4786,7 @@ "KeyState": { "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

" } }, "PendingWindowInDays": { @@ -4616,7 +4832,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n KMS key. To verify the signature, use the Verify operation, or use the\n public key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized\n user) uses their private key to sign a message. Anyone with the public key can verify that the\n message was signed with that particular private key and that the message hasn't changed since\n it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the KMS key and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of KMS.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" + "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n signing KMS key. To verify the signature, use the Verify operation, or use\n the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized\n user) uses their private key to sign a message. Anyone with the public key can verify that the\n message was signed with that particular private key and that the message hasn't changed since\n it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the KMS key and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of KMS.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" } }, "com.amazonaws.kms#SignRequest": { @@ -4794,6 +5010,9 @@ "input": { "target": "com.amazonaws.kms#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#InvalidArnException" @@ -4815,7 +5034,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or edits tags on a customer managed key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed key, but you cannot\n tag an Amazon Web Services\n managed key, an Amazon Web Services owned key, a custom key\n store, or an alias.

\n

You can also add tags to a KMS key while creating it (CreateKey) or\n replicating it (ReplicateKey).

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Adds or edits tags on a customer managed key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed key, but you cannot\n tag an Amazon Web Services\n managed key, an Amazon Web Services owned key, a custom key\n store, or an alias.

\n

You can also add tags to a KMS key while creating it (CreateKey) or\n replicating it (ReplicateKey).

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#TagResourceRequest": { @@ -4848,6 +5067,24 @@ }, "com.amazonaws.kms#TrentService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "KMS", + "arnNamespace": "kms", + "cloudFormationName": "KMS", + "cloudTrailEventSource": "kms.amazonaws.com", + "endpointPrefix": "kms" + }, + "aws.auth#sigv4": { + "name": "kms" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Key Management Service\n

Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.

\n \n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

\n

If you need to use FIPS 140-2 validated cryptographic modules when communicating with\n Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the\n available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.

\n

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account (root) access key ID and\n secret key for everyday work with KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary\n security credentials that you can use to sign requests.

\n

All KMS operations require Signature Version 4.

\n

\n Logging API Requests\n

\n

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", + "smithy.api#title": "AWS Key Management Service", + "smithy.api#xmlNamespace": { + "uri": "https://trent.amazonaws.com/doc/2014-11-01/" + } + }, "version": "2014-11-01", "operations": [ { @@ -4916,6 +5153,9 @@ { "target": "com.amazonaws.kms#GenerateDataKeyWithoutPlaintext" }, + { + "target": "com.amazonaws.kms#GenerateMac" + }, { "target": "com.amazonaws.kms#GenerateRandom" }, @@ -4993,26 +5233,11 @@ }, { "target": "com.amazonaws.kms#Verify" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "KMS", - "arnNamespace": "kms", - "cloudFormationName": "KMS", - "cloudTrailEventSource": "kms.amazonaws.com", - "endpointPrefix": "kms" - }, - "aws.auth#sigv4": { - "name": "kms" }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Key Management Service\n

Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.

\n \n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

\n

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account (root) access key ID and\n secret key for everyday work with KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary\n security credentials that you can use to sign requests.

\n

All KMS operations require Signature Version 4.

\n

\n Logging API Requests\n

\n

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", - "smithy.api#title": "AWS Key Management Service", - "smithy.api#xmlNamespace": { - "uri": "https://trent.amazonaws.com/doc/2014-11-01/" + { + "target": "com.amazonaws.kms#VerifyMac" } - } + ] }, "com.amazonaws.kms#TrustAnchorCertificateType": { "type": "string", @@ -5045,6 +5270,9 @@ "input": { "target": "com.amazonaws.kms#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#InvalidArnException" @@ -5063,7 +5291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes tags from a customer managed key. To delete a tag,\n specify the tag key and the KMS key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or\n return a response. To confirm that the operation worked, use the ListResourceTags operation.

\n\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Deletes tags from a customer managed key. To delete a tag,\n specify the tag key and the KMS key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or\n return a response. To confirm that the operation worked, use the ListResourceTags operation.

\n\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UntagResourceRequest": { @@ -5090,6 +5318,9 @@ "input": { "target": "com.amazonaws.kms#UpdateAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -5108,7 +5339,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an existing KMS alias with a different KMS key. Each alias is associated with\n only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the\n KMS key must be in the same Amazon Web Services account and Region.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

The current and new KMS key must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a KMS key, you can create, update, and delete the\n aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the\n response from the DescribeKey operation. To get the aliases of all KMS keys\n in the account, use the ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Associates an existing KMS alias with a different KMS key. Each alias is associated with\n only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the\n KMS key must be in the same Amazon Web Services account and Region.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

The current and new KMS key must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a KMS key, you can create, update, and delete the\n aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the\n response from the DescribeKey operation. To get the aliases of all KMS keys\n in the account, use the ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#UpdateAliasRequest": { @@ -5207,6 +5438,9 @@ "input": { "target": "com.amazonaws.kms#UpdateKeyDescriptionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -5225,7 +5459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdateKeyDescriptionRequest": { @@ -5252,6 +5486,9 @@ "input": { "target": "com.amazonaws.kms#UpdatePrimaryRegionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DisabledException" @@ -5273,7 +5510,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the primary key of a multi-Region key.

\n

This operation changes the replica key in the specified Region to a primary key and\n changes the former primary key to a replica key. For example, suppose you have a primary key\n in us-east-1 and a replica key in eu-west-2. If you run\n UpdatePrimaryRegion with a PrimaryRegion value of\n eu-west-2, the primary key is now the key in eu-west-2, and the\n key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

The primary key of a multi-Region key is the source for properties\n that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material\n origin, and automatic\n key rotation. It's the only key that can be replicated. You cannot delete the primary\n key until all replica keys are deleted.

\n

The key ID and primary Region that you specify uniquely identify the replica key that will\n become the primary key. The primary Region must already have a replica key. This operation\n does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica\n key, use the ReplicateKey operation.

\n

You can run this operation while using the affected multi-Region keys in cryptographic\n operations. This operation should not delay, interrupt, or cause failures in cryptographic\n operations.

\n

Even after this operation completes, the process of updating the primary Region might\n still be in progress for a few more seconds. Operations such as DescribeKey might\n display both the old and new primary keys as replicas. The old and new primary keys have a\n transient key state of Updating. The original key state is restored when the\n update is complete. While the key state is Updating, you can use the keys in\n cryptographic operations, but you cannot replicate the new primary key or perform certain\n management operations, such as enabling or disabling these keys. For details about the\n Updating key state, see Key state:\n Effect on your KMS key in the Key Management Service Developer Guide.

\n

This operation does not return any output. To verify that primary key is changed, use the\n DescribeKey operation.

\n

\n Cross-account use: No. You cannot use this operation in a\n different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " + "smithy.api#documentation": "

Changes the primary key of a multi-Region key.

\n

This operation changes the replica key in the specified Region to a primary key and\n changes the former primary key to a replica key. For example, suppose you have a primary key\n in us-east-1 and a replica key in eu-west-2. If you run\n UpdatePrimaryRegion with a PrimaryRegion value of\n eu-west-2, the primary key is now the key in eu-west-2, and the\n key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

The primary key of a multi-Region key is the source for properties\n that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material\n origin, and automatic\n key rotation. It's the only key that can be replicated. You cannot delete the primary\n key until all replica keys are deleted.

\n

The key ID and primary Region that you specify uniquely identify the replica key that will\n become the primary key. The primary Region must already have a replica key. This operation\n does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica\n key, use the ReplicateKey operation.

\n

You can run this operation while using the affected multi-Region keys in cryptographic\n operations. This operation should not delay, interrupt, or cause failures in cryptographic\n operations.

\n

Even after this operation completes, the process of updating the primary Region might\n still be in progress for a few more seconds. Operations such as DescribeKey might\n display both the old and new primary keys as replicas. The old and new primary keys have a\n transient key state of Updating. The original key state is restored when the\n update is complete. While the key state is Updating, you can use the keys in\n cryptographic operations, but you cannot replicate the new primary key or perform certain\n management operations, such as enabling or disabling these keys. For details about the\n Updating key state, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

This operation does not return any output. To verify that primary key is changed, use the\n DescribeKey operation.

\n

\n Cross-account use: No. You cannot use this operation in a\n different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdatePrimaryRegionRequest": { @@ -5333,7 +5570,107 @@ } ], "traits": { - "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified KMS\n key and signing algorithm, and the message hasn't changed since it was signed. If the\n signature is verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric KMS key. The\n signature is verified by using the public key in the same asymmetric KMS key.\n For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric KMS key, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the KMS key outside\n of KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric KMS key and then use the public key to verify the signature outside of KMS. The\n advantage of using the Verify operation is that it is performed within KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the KMS key to verify signatures.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" + "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified KMS\n key and signing algorithm, and the message hasn't changed since it was signed. If the\n signature is verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric KMS key. The\n signature is verified by using the public key in the same asymmetric KMS key.\n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric KMS key, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the KMS key outside\n of KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric KMS key and then use the public key to verify the signature outside of KMS. The\n advantage of using the Verify operation is that it is performed within KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the KMS key to verify signatures.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" + } + }, + "com.amazonaws.kms#VerifyMac": { + "type": "operation", + "input": { + "target": "com.amazonaws.kms#VerifyMacRequest" + }, + "output": { + "target": "com.amazonaws.kms#VerifyMacResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kms#DisabledException" + }, + { + "target": "com.amazonaws.kms#InvalidGrantTokenException" + }, + { + "target": "com.amazonaws.kms#InvalidKeyUsageException" + }, + { + "target": "com.amazonaws.kms#KeyUnavailableException" + }, + { + "target": "com.amazonaws.kms#KMSInternalException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidMacException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.kms#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC\n KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using\n the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC\n to the HMAC that you specify. If the HMACs are identical, the verification succeeds;\n otherwise, it fails.

\n \n

Verification indicates that the message hasn't changed since the HMAC was calculated, and\n the specified key was used to generate and verify the HMAC.

\n

This operation is part of KMS support for HMAC KMS keys. For details, see\n HMAC keys in KMS in the Key Management Service Developer Guide.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:VerifyMac (key policy)

\n

\n Related operations: GenerateMac\n

" + } + }, + "com.amazonaws.kms#VerifyMacRequest": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kms#PlaintextType", + "traits": { + "smithy.api#documentation": "

The message that will be used in the verification. Enter the same message that was used to\n generate the HMAC.

\n

\n GenerateMac and VerifyMac do not provide special handling\n for message digests. If you generated an HMAC for a hash digest of a message, you must verify\n the HMAC for the same hash digest.

", + "smithy.api#required": {} + } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The KMS key that will be used in the verification.

\n \n

Enter a key ID of the KMS\n key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac operation fails.

", + "smithy.api#required": {} + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.

", + "smithy.api#required": {} + } + }, + "Mac": { + "target": "com.amazonaws.kms#CiphertextType", + "traits": { + "smithy.api#documentation": "

The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

", + "smithy.api#required": {} + } + }, + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", + "traits": { + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" + } + } + } + }, + "com.amazonaws.kms#VerifyMacResponse": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The HMAC KMS key used in the verification.

" + } + }, + "MacValid": { + "target": "com.amazonaws.kms#BooleanType", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the HMAC was verified. A value of \n True indicates that the HMAC (Mac) was generated with the specified\n Message, HMAC KMS key (KeyID) and\n MacAlgorithm..

\n

If the HMAC is not verified, the VerifyMac operation fails with a\n KMSInvalidMacException exception. This exception indicates that one or more of\n the inputs changed since the HMAC was computed.

" + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm used in the verification.

" + } + } } }, "com.amazonaws.kms#VerifyRequest": { diff --git a/codegen/sdk/aws-models/lightsail.json b/codegen/sdk/aws-models/lightsail.json index 7b61e4d6b80..ca5c2ad1470 100644 --- a/codegen/sdk/aws-models/lightsail.json +++ b/codegen/sdk/aws-models/lightsail.json @@ -177,6 +177,61 @@ ] } }, + "com.amazonaws.lightsail#AccountLevelBpaSync": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus", + "traits": { + "smithy.api#documentation": "

The status of the account-level BPA synchronization.

\n\n

The following statuses are possible:

\n \n \n

You might need to complete further actions if the status is Failed or\n Defaulted. The message parameter provides more information for\n those statuses.

\n " + } + }, + "lastSyncedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of when the account-level BPA configuration was last synchronized. This\n value is null when the account-level BPA configuration has not been synchronized.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#BPAStatusMessage", + "traits": { + "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n\n

The following messages are possible:

\n " + } + }, + "bpaImpactsLightsail": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.

\n\n

The account-level BPA feature of Amazon S3 provides centralized controls to limit\n public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and\n object permissions that are configured. Lightsail buckets take into account the\n Amazon S3 account-level BPA configuration when allowing or denying public access. To\n do this, Lightsail periodically fetches the account-level BPA configuration\n from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail\n buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects\n Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#AccountLevelBpaSyncStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InSync", + "name": "InSync" + }, + { + "value": "Failed", + "name": "Failed" + }, + { + "value": "NeverSynced", + "name": "NeverSynced" + }, + { + "value": "Defaulted", + "name": "Defaulted" + } + ] + } + }, "com.amazonaws.lightsail#AccountSetupInProgressException": { "type": "structure", "members": { @@ -987,6 +1042,29 @@ "target": "com.amazonaws.lightsail#AvailabilityZone" } }, + "com.amazonaws.lightsail#BPAStatusMessage": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEFAULTED_FOR_SLR_MISSING", + "name": "DEFAULTED_FOR_SLR_MISSING" + }, + { + "value": "SYNC_ON_HOLD", + "name": "SYNC_ON_HOLD" + }, + { + "value": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD", + "name": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" + }, + { + "value": "Unknown", + "name": "Unknown" + } + ] + } + }, "com.amazonaws.lightsail#Base64": { "type": "string" }, @@ -1220,7 +1298,7 @@ "destination": { "target": "com.amazonaws.lightsail#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket where the access is saved. The destination can be a Lightsail\n bucket in the same account, and in the same AWS Region as the source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n " + "smithy.api#documentation": "

The name of the bucket where the access logs are saved. The destination can be a\n Lightsail bucket in the same account, and in the same AWS Region as the source\n bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n " } }, "prefix": { @@ -3293,7 +3371,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a deployment for your Amazon Lightsail container service.

\n\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n\n

You can deploy containers to your container service using container images from a public\n registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", + "smithy.api#documentation": "

Creates a deployment for your Amazon Lightsail container service.

\n\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n\n

You can deploy containers to your container service using container images from a public\n registry such as Amazon ECR Public, or from your local machine. For more information, see\n Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", @@ -8108,7 +8186,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets.

\n\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide..

", + "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets. The information returned\n includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access feature for your Lightsail buckets.

\n\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBuckets", @@ -8153,6 +8231,12 @@ "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

A next page token is not returned if there are no more results to display.

\n\n

To get the next page of results, perform another GetBuckets request and\n specify the next page token using the pageToken parameter.

" } + }, + "accountLevelBpaSync": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSync", + "traits": { + "smithy.api#documentation": "

An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.

\n\n

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

" + } } } }, @@ -9174,7 +9258,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your dsitribution.

", + "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDistributionBundles", @@ -18582,7 +18666,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your dsitribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly AWS billing\n cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", + "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly AWS billing\n cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateDistributionBundle", diff --git a/codegen/sdk/aws-models/lookoutmetrics.json b/codegen/sdk/aws-models/lookoutmetrics.json index f16c167faf2..adcc54b2102 100644 --- a/codegen/sdk/aws-models/lookoutmetrics.json +++ b/codegen/sdk/aws-models/lookoutmetrics.json @@ -728,6 +728,84 @@ "smithy.api#pattern": "^arn:([a-z\\d-]+):.*:.*:.*:.+$" } }, + "com.amazonaws.lookoutmetrics#AttributeValue": { + "type": "structure", + "members": { + "S": { + "target": "com.amazonaws.lookoutmetrics#StringAttributeValue", + "traits": { + "smithy.api#documentation": "

A string.

" + } + }, + "N": { + "target": "com.amazonaws.lookoutmetrics#NumberAttributeValue", + "traits": { + "smithy.api#documentation": "

A number.

" + } + }, + "B": { + "target": "com.amazonaws.lookoutmetrics#BinaryAttributeValue", + "traits": { + "smithy.api#documentation": "

A binary value.

" + } + }, + "SS": { + "target": "com.amazonaws.lookoutmetrics#StringListAttributeValue", + "traits": { + "smithy.api#documentation": "

A list of strings.

" + } + }, + "NS": { + "target": "com.amazonaws.lookoutmetrics#NumberListAttributeValue", + "traits": { + "smithy.api#documentation": "

A list of numbers.

" + } + }, + "BS": { + "target": "com.amazonaws.lookoutmetrics#BinaryListAttributeValue", + "traits": { + "smithy.api#documentation": "

A list of binary values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An attribute value.

" + } + }, + "com.amazonaws.lookoutmetrics#AutoDetectionMetricSource": { + "type": "structure", + "members": { + "S3SourceConfig": { + "target": "com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig", + "traits": { + "smithy.api#documentation": "

The source's source config.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An auto detection metric source.

" + } + }, + "com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig": { + "type": "structure", + "members": { + "TemplatedPathList": { + "target": "com.amazonaws.lookoutmetrics#TemplatedPathList", + "traits": { + "smithy.api#documentation": "

The config's templated path list.

" + } + }, + "HistoricalDataPathList": { + "target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList", + "traits": { + "smithy.api#documentation": "

The config's historical data path list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An auto detection source config.

" + } + }, "com.amazonaws.lookoutmetrics#BackTestAnomalyDetector": { "type": "operation", "input": { @@ -778,6 +856,15 @@ "type": "structure", "members": {} }, + "com.amazonaws.lookoutmetrics#BinaryAttributeValue": { + "type": "string" + }, + "com.amazonaws.lookoutmetrics#BinaryListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#BinaryAttributeValue" + } + }, "com.amazonaws.lookoutmetrics#Boolean": { "type": "boolean", "traits": { @@ -833,6 +920,25 @@ "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" } }, + "com.amazonaws.lookoutmetrics#Confidence": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.lookoutmetrics#ConflictException": { "type": "structure", "members": { @@ -1810,6 +1916,234 @@ } } }, + "com.amazonaws.lookoutmetrics#DetectMetricSetConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfigRequest" + }, + "output": { + "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutmetrics#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lookoutmetrics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Detects an Amazon S3 dataset's file format, interval, and offset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/DetectMetricSetConfig", + "code": 200 + } + } + }, + "com.amazonaws.lookoutmetrics#DetectMetricSetConfigRequest": { + "type": "structure", + "members": { + "AnomalyDetectorArn": { + "target": "com.amazonaws.lookoutmetrics#Arn", + "traits": { + "smithy.api#documentation": "

An anomaly detector ARN.

", + "smithy.api#required": {} + } + }, + "AutoDetectionMetricSource": { + "target": "com.amazonaws.lookoutmetrics#AutoDetectionMetricSource", + "traits": { + "smithy.api#documentation": "

A data source.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lookoutmetrics#DetectMetricSetConfigResponse": { + "type": "structure", + "members": { + "DetectedMetricSetConfig": { + "target": "com.amazonaws.lookoutmetrics#DetectedMetricSetConfig", + "traits": { + "smithy.api#documentation": "

The inferred dataset configuration for the datasource.

" + } + } + } + }, + "com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor": { + "type": "structure", + "members": { + "FileCompression": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's file compression.

" + } + }, + "Charset": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's charset.

" + } + }, + "ContainsHeader": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

Whether the format includes a header.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's delimiter.

" + } + }, + "HeaderList": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's header list.

" + } + }, + "QuoteSymbol": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's quote symbol.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of an inferred CSV format.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedField": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.lookoutmetrics#AttributeValue", + "traits": { + "smithy.api#documentation": "

The field's value.

" + } + }, + "Confidence": { + "target": "com.amazonaws.lookoutmetrics#Confidence", + "traits": { + "smithy.api#documentation": "

The field's confidence.

" + } + }, + "Message": { + "target": "com.amazonaws.lookoutmetrics#Message", + "traits": { + "smithy.api#documentation": "

The field's message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An inferred field.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor": { + "type": "structure", + "members": { + "CsvFormatDescriptor": { + "target": "com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor", + "traits": { + "smithy.api#documentation": "

Details about a CSV format.

" + } + }, + "JsonFormatDescriptor": { + "target": "com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor", + "traits": { + "smithy.api#documentation": "

Details about a JSON format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of an inferred data format.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor": { + "type": "structure", + "members": { + "FileCompression": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's file compression.

" + } + }, + "Charset": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's character set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A detected JSON format descriptor.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedMetricSetConfig": { + "type": "structure", + "members": { + "Offset": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The dataset's offset.

" + } + }, + "MetricSetFrequency": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The dataset's interval.

" + } + }, + "MetricSource": { + "target": "com.amazonaws.lookoutmetrics#DetectedMetricSource", + "traits": { + "smithy.api#documentation": "

The dataset's data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An inferred dataset configuration.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedMetricSource": { + "type": "structure", + "members": { + "S3SourceConfig": { + "target": "com.amazonaws.lookoutmetrics#DetectedS3SourceConfig", + "traits": { + "smithy.api#documentation": "

The data source's source configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An inferred data source.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedS3SourceConfig": { + "type": "structure", + "members": { + "FileFormatDescriptor": { + "target": "com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor", + "traits": { + "smithy.api#documentation": "

The source's file format descriptor.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An inferred source configuration.

" + } + }, "com.amazonaws.lookoutmetrics#DimensionContribution": { "type": "structure", "members": { @@ -3046,6 +3380,9 @@ { "target": "com.amazonaws.lookoutmetrics#DescribeMetricSet" }, + { + "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfig" + }, { "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroup" }, @@ -3339,6 +3676,15 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.lookoutmetrics#NumberAttributeValue": { + "type": "string" + }, + "com.amazonaws.lookoutmetrics#NumberListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#NumberAttributeValue" + } + }, "com.amazonaws.lookoutmetrics#Offset": { "type": "integer", "traits": { @@ -3808,6 +4154,15 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.lookoutmetrics#StringAttributeValue": { + "type": "string" + }, + "com.amazonaws.lookoutmetrics#StringListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#StringAttributeValue" + } + }, "com.amazonaws.lookoutmetrics#SubnetId": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/macie2.json b/codegen/sdk/aws-models/macie2.json index a5804c15f64..689b53c614e 100644 --- a/codegen/sdk/aws-models/macie2.json +++ b/codegen/sdk/aws-models/macie2.json @@ -1110,6 +1110,13 @@ "smithy.api#jsonName": "jobId" } }, + "originType": { + "target": "com.amazonaws.macie2#OriginType", + "traits": { + "smithy.api#documentation": "

Specifies how Amazon Macie found the sensitive data that produced the finding: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job.

", + "smithy.api#jsonName": "originType" + } + }, "result": { "target": "com.amazonaws.macie2#ClassificationResult", "traits": { @@ -1119,7 +1126,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about a sensitive data finding, including the classification job that produced the finding.

" + "smithy.api#documentation": "

Provides information about a sensitive data finding and the details of the finding.

" } }, "com.amazonaws.macie2#ClassificationExportConfiguration": { @@ -4423,7 +4430,7 @@ "findingIds": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array of strings that lists the unique identifiers for the findings to retrieve.

", + "smithy.api#documentation": "

An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.

", "smithy.api#jsonName": "findingIds", "smithy.api#required": {} } @@ -5262,7 +5269,7 @@ "com.amazonaws.macie2#JobComparator": { "type": "string", "traits": { - "smithy.api#documentation": "

The operator to use in a condition. Valid values are:

", + "smithy.api#documentation": "

The operator to use in a condition. Depending on the type of condition, possible values are:

", "smithy.api#enum": [ { "value": "EQ", @@ -7009,6 +7016,18 @@ ] } }, + "com.amazonaws.macie2#OriginType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Specifies how Amazon Macie found the sensitive data that produced a finding. The only possible value is:

", + "smithy.api#enum": [ + { + "value": "SENSITIVE_DATA_DISCOVERY_JOB", + "name": "SENSITIVE_DATA_DISCOVERY_JOB" + } + ] + } + }, "com.amazonaws.macie2#Page": { "type": "structure", "members": { @@ -7231,6 +7250,9 @@ "type": "list", "member": { "target": "com.amazonaws.macie2#Range" + }, + "traits": { + "smithy.api#documentation": "

Specifies the locations of occurrences of sensitive data in a non-binary text file.

" } }, "com.amazonaws.macie2#Record": { @@ -7259,6 +7281,9 @@ "type": "list", "member": { "target": "com.amazonaws.macie2#Record" + }, + "traits": { + "smithy.api#documentation": "

Specifies the locations of occurrences of sensitive data in an Apache Avro object container or a structured data file.

" } }, "com.amazonaws.macie2#RelationshipStatus": { @@ -8909,7 +8934,7 @@ "tagKeys": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

", + "smithy.api#documentation": "

One or more tags (keys) to remove from the resource. In an HTTP request to remove multiple tags, append the tagKeys parameter and argument for each tag to remove, and separate them with an ampersand (&).

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } diff --git a/codegen/sdk/aws-models/mediatailor.json b/codegen/sdk/aws-models/mediatailor.json index 48783982f23..e6301ccd19f 100644 --- a/codegen/sdk/aws-models/mediatailor.json +++ b/codegen/sdk/aws-models/mediatailor.json @@ -234,7 +234,7 @@ "AdSegmentUrlPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

" + "smithy.api#documentation": "

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

" } }, "ContentSegmentUrlPrefix": { @@ -310,6 +310,13 @@ "smithy.api#documentation": "

The tags to assign to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The tier for this channel. STANDARD tier channels can contain live programs.

", + "smithy.api#required": {} + } } }, "traits": { @@ -477,6 +484,12 @@ "smithy.api#documentation": "

The tags to assign to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#Tier", + "traits": { + "smithy.api#documentation": "

The tier of the channel.

" + } } } }, @@ -537,6 +550,112 @@ "smithy.api#documentation": "

The tags assigned to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The channel's tier.

" + } + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreateLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreateLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates name for a specific live source in a source location.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

A list of HTTP package configuration parameters for this live source.

", + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags to assign to the live source.

", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the live source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source.

" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location associated with the VOD source.

" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags assigned to the live source.

", + "smithy.api#jsonName": "tags" + } } } }, @@ -673,6 +792,12 @@ "smithy.api#required": {} } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the LiveSource for this Program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -698,8 +823,7 @@ "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The name that's used to refer to a VOD source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name that's used to refer to a VOD source.

" } } } @@ -731,6 +855,12 @@ "smithy.api#documentation": "

The timestamp of when the program was created.

" } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the LiveSource for this Program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -797,7 +927,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -856,7 +989,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -896,7 +1032,7 @@ "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { - "smithy.api#documentation": "

An array of HTTP package configuration parameters for this VOD source.

", + "smithy.api#documentation": "

A list of HTTP package configuration parameters for this VOD source.

", "smithy.api#required": {} } }, @@ -949,7 +1085,7 @@ "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { - "smithy.api#documentation": "

The ARN for the VOD source.

" + "smithy.api#documentation": "

The last modified time of the VOD source.

" } }, "SourceLocationName": { @@ -1133,6 +1269,48 @@ "type": "structure", "members": {} }, + "com.amazonaws.mediatailor#DeleteLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Deletes a specific live source in a specific source location.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#DeleteLiveSourceRequest": { + "type": "structure", + "members": { + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteLiveSourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.mediatailor#DeletePlaybackConfiguration": { "type": "operation", "input": { @@ -1414,6 +1592,98 @@ "smithy.api#documentation": "

The tags assigned to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The channel's tier.

" + } + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DescribeLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DescribeLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Provides details about a specific live source in a specific source location.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSourceRequest": { + "type": "structure", + "members": { + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the live source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source.

" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location associated with the VOD source.

" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags assigned to the live source.

", + "smithy.api#jsonName": "tags" + } } } }, @@ -1482,6 +1752,12 @@ "smithy.api#documentation": "

The timestamp of when the program was created.

" } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the LiveSource for this Program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -1578,7 +1854,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -1657,7 +1936,7 @@ "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { - "smithy.api#documentation": "

The ARN for the VOD source.

" + "smithy.api#documentation": "

The last modified time of the VOD source.

" } }, "SourceLocationName": { @@ -1785,7 +2064,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfScheduleEntry", "traits": { - "smithy.api#documentation": "

An array of schedule entries for the channel.

" + "smithy.api#documentation": "

A list of schedule entries for the channel.

" } }, "NextToken": { @@ -2162,7 +2441,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfAlert", "traits": { - "smithy.api#documentation": "

An array of alerts that are associated with this resource.

" + "smithy.api#documentation": "

A list of alerts that are associated with this resource.

" } }, "NextToken": { @@ -2221,7 +2500,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfChannel", "traits": { - "smithy.api#documentation": "

An array of channels that are associated with this account.

" + "smithy.api#documentation": "

A list of channels that are associated with this account.

" } }, "NextToken": { @@ -2232,6 +2511,73 @@ } } }, + "com.amazonaws.mediatailor#ListLiveSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListLiveSourcesRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListLiveSourcesResponse" + }, + "traits": { + "smithy.api#documentation": "

lists all the live sources in a source location.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/liveSources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.mediatailor#ListLiveSourcesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": "

Upper bound on number of records to return. The maximum number of results is 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

Pagination token from the GET list request. Use the token to fetch the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#ListLiveSourcesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfLiveSource", + "traits": { + "smithy.api#documentation": "

Lists the live sources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

Pagination token from the list request. Use the token to fetch the next page of results.

" + } + } + } + }, "com.amazonaws.mediatailor#ListPlaybackConfigurations": { "type": "operation", "input": { @@ -2410,7 +2756,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfSourceLocation", "traits": { - "smithy.api#documentation": "

An array of source locations.

" + "smithy.api#documentation": "

A list of source locations.

" } }, "NextToken": { @@ -2555,6 +2901,61 @@ "smithy.api#documentation": "

The configuration for pre-roll ad insertion.

" } }, + "com.amazonaws.mediatailor#LiveSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN for the live source.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations for the live source.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was last modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name that's used to refer to a live source.

", + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags assigned to the live source.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Live source configuration parameters.

" + } + }, "com.amazonaws.mediatailor#LogConfiguration": { "type": "structure", "members": { @@ -2618,6 +3019,9 @@ { "target": "com.amazonaws.mediatailor#CreateChannel" }, + { + "target": "com.amazonaws.mediatailor#CreateLiveSource" + }, { "target": "com.amazonaws.mediatailor#CreatePrefetchSchedule" }, @@ -2636,6 +3040,9 @@ { "target": "com.amazonaws.mediatailor#DeleteChannelPolicy" }, + { + "target": "com.amazonaws.mediatailor#DeleteLiveSource" + }, { "target": "com.amazonaws.mediatailor#DeletePlaybackConfiguration" }, @@ -2654,6 +3061,9 @@ { "target": "com.amazonaws.mediatailor#DescribeChannel" }, + { + "target": "com.amazonaws.mediatailor#DescribeLiveSource" + }, { "target": "com.amazonaws.mediatailor#DescribeProgram" }, @@ -2681,6 +3091,9 @@ { "target": "com.amazonaws.mediatailor#ListChannels" }, + { + "target": "com.amazonaws.mediatailor#ListLiveSources" + }, { "target": "com.amazonaws.mediatailor#ListPlaybackConfigurations" }, @@ -2717,6 +3130,9 @@ { "target": "com.amazonaws.mediatailor#UpdateChannel" }, + { + "target": "com.amazonaws.mediatailor#UpdateLiveSource" + }, { "target": "com.amazonaws.mediatailor#UpdateSourceLocation" }, @@ -3467,6 +3883,12 @@ "smithy.api#required": {} } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source used for the program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -3496,8 +3918,7 @@ "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The name of the VOD source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the VOD source.

" } } }, @@ -3550,11 +3971,20 @@ "type": "structure", "members": { "BaseUrl": { - "target": "com.amazonaws.mediatailor#__string" + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.

" + } }, "Name": { - "target": "com.amazonaws.mediatailor#__string" + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

" + } } + }, + "traits": { + "smithy.api#documentation": "

The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.

" } }, "com.amazonaws.mediatailor#SlateSource": { @@ -3619,7 +4049,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

The segment delivery configurations for the source location.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -3780,9 +4213,30 @@ } } }, + "com.amazonaws.mediatailor#Tier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BASIC", + "name": "BASIC" + }, + { + "value": "STANDARD", + "name": "STANDARD" + } + ] + } + }, "com.amazonaws.mediatailor#Transition": { "type": "structure", "members": { + "DurationMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "

The duration of the live program in seconds.

" + } + }, "RelativePosition": { "target": "com.amazonaws.mediatailor#RelativePosition", "traits": { @@ -3969,6 +4423,105 @@ "smithy.api#documentation": "

The tags assigned to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The channel's tier.

" + } + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UpdateLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#UpdateLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Updates a specific live source in a specific source location.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

A list of HTTP package configurations for the live source on this account.

", + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the live source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source.

" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location associated with the VOD source.

" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags assigned to the live source.

", + "smithy.api#jsonName": "tags" + } } } }, @@ -4012,7 +4565,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -4064,7 +4620,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -4104,7 +4663,7 @@ "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { - "smithy.api#documentation": "

An array of HTTP package configurations for the VOD source on this account.

", + "smithy.api#documentation": "

A list of HTTP package configurations for the VOD source on this account.

", "smithy.api#required": {} } }, @@ -4150,7 +4709,7 @@ "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { - "smithy.api#documentation": "

The ARN for the VOD source.

" + "smithy.api#documentation": "

The last modified time of the VOD source.

" } }, "SourceLocationName": { @@ -4276,6 +4835,12 @@ "target": "com.amazonaws.mediatailor#Channel" } }, + "com.amazonaws.mediatailor#__listOfLiveSource": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#LiveSource" + } + }, "com.amazonaws.mediatailor#__listOfPlaybackConfiguration": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/mgn.json b/codegen/sdk/aws-models/mgn.json index 4a81ea02397..788fe0f8e93 100644 --- a/codegen/sdk/aws-models/mgn.json +++ b/codegen/sdk/aws-models/mgn.json @@ -50,9 +50,8 @@ "aws.api#service": { "sdkId": "mgn", "arnNamespace": "mgn", - "cloudFormationName": "ApplicationMigrationService", - "cloudTrailEventSource": "mgn.amazonaws.com", - "endpointPrefix": "mgn" + "awsProductName": "mgn", + "cloudTrailEventSource": "mgn.amazonaws.com" }, "aws.auth#sigv4": { "name": "mgn" @@ -60,16 +59,16 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ + "content-type", "x-amz-content-sha256", - "x-amzn-trace-id", "x-amz-user-agent", - "content-type" + "x-amzn-trace-id" ], "additionalExposedHeaders": [ - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", - "x-amzn-requestid" + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amz-apigw-id" ] }, "smithy.api#documentation": "

The Application Migration Service service.

", @@ -113,12 +112,12 @@ "traits": { "smithy.api#enum": [ { - "value": "LEGACY_BIOS", - "name": "LEGACY_BIOS" + "name": "LEGACY_BIOS", + "value": "LEGACY_BIOS" }, { - "value": "UEFI", - "name": "UEFI" + "name": "UEFI", + "value": "UEFI" } ] } @@ -177,8 +176,8 @@ "traits": { "smithy.api#documentation": "

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

", "smithy.api#http": { - "method": "POST", "uri": "/ChangeServerLifeCycleState", + "method": "POST", "code": 200 } } @@ -222,16 +221,16 @@ "traits": { "smithy.api#enum": [ { - "value": "READY_FOR_TEST", - "name": "READY_FOR_TEST" + "name": "READY_FOR_TEST", + "value": "READY_FOR_TEST" }, { - "value": "READY_FOR_CUTOVER", - "name": "READY_FOR_CUTOVER" + "name": "READY_FOR_CUTOVER", + "value": "READY_FOR_CUTOVER" }, { - "value": "CUTOVER", - "name": "CUTOVER" + "name": "CUTOVER", + "value": "CUTOVER" } ] } @@ -298,8 +297,8 @@ "traits": { "smithy.api#documentation": "

Creates a new ReplicationConfigurationTemplate.

", "smithy.api#http": { - "method": "POST", "uri": "/CreateReplicationConfigurationTemplate", + "method": "POST", "code": 201 } } @@ -423,68 +422,68 @@ "traits": { "smithy.api#enum": [ { - "value": "AGENT_NOT_SEEN", - "name": "AGENT_NOT_SEEN" + "name": "AGENT_NOT_SEEN", + "value": "AGENT_NOT_SEEN" }, { - "value": "SNAPSHOTS_FAILURE", - "name": "SNAPSHOTS_FAILURE" + "name": "SNAPSHOTS_FAILURE", + "value": "SNAPSHOTS_FAILURE" }, { - "value": "NOT_CONVERGING", - "name": "NOT_CONVERGING" + "name": "NOT_CONVERGING", + "value": "NOT_CONVERGING" }, { - "value": "UNSTABLE_NETWORK", - "name": "UNSTABLE_NETWORK" + "name": "UNSTABLE_NETWORK", + "value": "UNSTABLE_NETWORK" }, { - "value": "FAILED_TO_CREATE_SECURITY_GROUP", - "name": "FAILED_TO_CREATE_SECURITY_GROUP" + "name": "FAILED_TO_CREATE_SECURITY_GROUP", + "value": "FAILED_TO_CREATE_SECURITY_GROUP" }, { - "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER", - "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER" + "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER", + "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER" }, { - "value": "FAILED_TO_BOOT_REPLICATION_SERVER", - "name": "FAILED_TO_BOOT_REPLICATION_SERVER" + "name": "FAILED_TO_BOOT_REPLICATION_SERVER", + "value": "FAILED_TO_BOOT_REPLICATION_SERVER" }, { - "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", - "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" + "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", + "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" }, { - "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", - "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" }, { - "value": "FAILED_TO_CREATE_STAGING_DISKS", - "name": "FAILED_TO_CREATE_STAGING_DISKS" + "name": "FAILED_TO_CREATE_STAGING_DISKS", + "value": "FAILED_TO_CREATE_STAGING_DISKS" }, { - "value": "FAILED_TO_ATTACH_STAGING_DISKS", - "name": "FAILED_TO_ATTACH_STAGING_DISKS" + "name": "FAILED_TO_ATTACH_STAGING_DISKS", + "value": "FAILED_TO_ATTACH_STAGING_DISKS" }, { - "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", - "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" + "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", + "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" }, { - "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", - "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" + "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", + "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" }, { - "value": "FAILED_TO_START_DATA_TRANSFER", - "name": "FAILED_TO_START_DATA_TRANSFER" + "name": "FAILED_TO_START_DATA_TRANSFER", + "value": "FAILED_TO_START_DATA_TRANSFER" }, { - "value": "UNSUPPORTED_VM_CONFIGURATION", - "name": "UNSUPPORTED_VM_CONFIGURATION" + "name": "UNSUPPORTED_VM_CONFIGURATION", + "value": "UNSUPPORTED_VM_CONFIGURATION" }, { - "value": "LAST_SNAPSHOT_JOB_FAILED", - "name": "LAST_SNAPSHOT_JOB_FAILED" + "name": "LAST_SNAPSHOT_JOB_FAILED", + "value": "LAST_SNAPSHOT_JOB_FAILED" } ] } @@ -691,24 +690,24 @@ "traits": { "smithy.api#enum": [ { - "value": "NOT_STARTED", - "name": "NOT_STARTED" + "name": "NOT_STARTED", + "value": "NOT_STARTED" }, { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" }, { - "value": "SUCCEEDED", - "name": "SUCCEEDED" + "name": "SUCCEEDED", + "value": "SUCCEEDED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "SKIPPED", - "name": "SKIPPED" + "name": "SKIPPED", + "value": "SKIPPED" } ] } @@ -724,52 +723,52 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "INITIATING", - "name": "INITIATING" + "name": "INITIATING", + "value": "INITIATING" }, { - "value": "INITIAL_SYNC", - "name": "INITIAL_SYNC" + "name": "INITIAL_SYNC", + "value": "INITIAL_SYNC" }, { - "value": "BACKLOG", - "name": "BACKLOG" + "name": "BACKLOG", + "value": "BACKLOG" }, { - "value": "CREATING_SNAPSHOT", - "name": "CREATING_SNAPSHOT" + "name": "CREATING_SNAPSHOT", + "value": "CREATING_SNAPSHOT" }, { - "value": "CONTINUOUS", - "name": "CONTINUOUS" + "name": "CONTINUOUS", + "value": "CONTINUOUS" }, { - "value": "PAUSED", - "name": "PAUSED" + "name": "PAUSED", + "value": "PAUSED" }, { - "value": "RESCAN", - "name": "RESCAN" + "name": "RESCAN", + "value": "RESCAN" }, { - "value": "STALLED", - "name": "STALLED" + "name": "STALLED", + "value": "STALLED" }, { - "value": "DISCONNECTED", - "name": "DISCONNECTED" + "name": "DISCONNECTED", + "value": "DISCONNECTED" }, { - "value": "PENDING_SNAPSHOT_SHIPPING", - "name": "PENDING_SNAPSHOT_SHIPPING" + "name": "PENDING_SNAPSHOT_SHIPPING", + "value": "PENDING_SNAPSHOT_SHIPPING" }, { - "value": "SHIPPING_SNAPSHOT", - "name": "SHIPPING_SNAPSHOT" + "name": "SHIPPING_SNAPSHOT", + "value": "SHIPPING_SNAPSHOT" } ] } @@ -796,8 +795,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Job by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteJob", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -841,8 +840,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Replication Configuration Template by ID

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteReplicationConfigurationTemplate", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -886,8 +885,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single source server by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteSourceServer", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -931,8 +930,8 @@ "traits": { "smithy.api#documentation": "

Deletes a given vCenter client by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteVcenterClient", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -969,15 +968,15 @@ "traits": { "smithy.api#documentation": "

Retrieves detailed job log items with paging.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeJobLogItems", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1042,15 +1041,15 @@ "traits": { "smithy.api#documentation": "

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeJobs", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1061,8 +1060,7 @@ "filters": { "target": "com.amazonaws.mgn#DescribeJobsRequestFilters", "traits": { - "smithy.api#documentation": "

Request to describe Job log filters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Request to describe Job log filters.

" } }, "maxResults": { @@ -1156,15 +1154,15 @@ "traits": { "smithy.api#documentation": "

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeReplicationConfigurationTemplates", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1175,8 +1173,7 @@ "replicationConfigurationTemplateIDs": { "target": "com.amazonaws.mgn#ReplicationConfigurationTemplateIDs", "traits": { - "smithy.api#documentation": "

Request to describe Replication Configuration template by template IDs.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Request to describe Replication Configuration template by template IDs.

" } }, "maxResults": { @@ -1229,15 +1226,15 @@ "traits": { "smithy.api#documentation": "

Retrieves all SourceServers or multiple SourceServers by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeSourceServers", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1248,8 +1245,7 @@ "filters": { "target": "com.amazonaws.mgn#DescribeSourceServersRequestFilters", "traits": { - "smithy.api#documentation": "

Request to filter Source Servers list.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Request to filter Source Servers list.

" } }, "maxResults": { @@ -1349,15 +1345,15 @@ "traits": { "smithy.api#documentation": "

Returns a list of the installed vCenter clients.

", "smithy.api#http": { - "method": "GET", "uri": "/DescribeVcenterClients", + "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1420,8 +1416,8 @@ "traits": { "smithy.api#documentation": "

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { - "method": "POST", "uri": "/DisconnectFromService", + "method": "POST", "code": 200 } } @@ -1514,8 +1510,8 @@ "traits": { "smithy.api#documentation": "

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { - "method": "POST", "uri": "/FinalizeCutover", + "method": "POST", "code": 200 } } @@ -1574,8 +1570,8 @@ "traits": { "smithy.api#documentation": "

Lists all LaunchConfigurations available, filtered by Source Server IDs.

", "smithy.api#http": { - "method": "POST", "uri": "/GetLaunchConfiguration", + "method": "POST", "code": 200 }, "smithy.api#readonly": {} @@ -1612,8 +1608,8 @@ "traits": { "smithy.api#documentation": "

Lists all ReplicationConfigurations, filtered by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/GetReplicationConfiguration", + "method": "POST", "code": 200 }, "smithy.api#readonly": {} @@ -1704,8 +1700,8 @@ "traits": { "smithy.api#documentation": "

Initialize Application Migration Service.

", "smithy.api#http": { - "method": "POST", "uri": "/InitializeService", + "method": "POST", "code": 204 } } @@ -1868,68 +1864,68 @@ "traits": { "smithy.api#enum": [ { - "value": "JOB_START", - "name": "JOB_START" + "name": "JOB_START", + "value": "JOB_START" }, { - "value": "SERVER_SKIPPED", - "name": "SERVER_SKIPPED" + "name": "SERVER_SKIPPED", + "value": "SERVER_SKIPPED" }, { - "value": "CLEANUP_START", - "name": "CLEANUP_START" + "name": "CLEANUP_START", + "value": "CLEANUP_START" }, { - "value": "CLEANUP_END", - "name": "CLEANUP_END" + "name": "CLEANUP_END", + "value": "CLEANUP_END" }, { - "value": "CLEANUP_FAIL", - "name": "CLEANUP_FAIL" + "name": "CLEANUP_FAIL", + "value": "CLEANUP_FAIL" }, { - "value": "SNAPSHOT_START", - "name": "SNAPSHOT_START" + "name": "SNAPSHOT_START", + "value": "SNAPSHOT_START" }, { - "value": "SNAPSHOT_END", - "name": "SNAPSHOT_END" + "name": "SNAPSHOT_END", + "value": "SNAPSHOT_END" }, { - "value": "SNAPSHOT_FAIL", - "name": "SNAPSHOT_FAIL" + "name": "SNAPSHOT_FAIL", + "value": "SNAPSHOT_FAIL" }, { - "value": "USING_PREVIOUS_SNAPSHOT", - "name": "USING_PREVIOUS_SNAPSHOT" + "name": "USING_PREVIOUS_SNAPSHOT", + "value": "USING_PREVIOUS_SNAPSHOT" }, { - "value": "CONVERSION_START", - "name": "CONVERSION_START" + "name": "CONVERSION_START", + "value": "CONVERSION_START" }, { - "value": "CONVERSION_END", - "name": "CONVERSION_END" + "name": "CONVERSION_END", + "value": "CONVERSION_END" }, { - "value": "CONVERSION_FAIL", - "name": "CONVERSION_FAIL" + "name": "CONVERSION_FAIL", + "value": "CONVERSION_FAIL" }, { - "value": "LAUNCH_START", - "name": "LAUNCH_START" + "name": "LAUNCH_START", + "value": "LAUNCH_START" }, { - "value": "LAUNCH_FAILED", - "name": "LAUNCH_FAILED" + "name": "LAUNCH_FAILED", + "value": "LAUNCH_FAILED" }, { - "value": "JOB_CANCEL", - "name": "JOB_CANCEL" + "name": "JOB_CANCEL", + "value": "JOB_CANCEL" }, { - "value": "JOB_END", - "name": "JOB_END" + "name": "JOB_END", + "value": "JOB_END" } ] } @@ -1992,10 +1988,7 @@ ], "traits": { "aws.api#arn": { - "template": "job/{jobID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "job/{jobID}" } } }, @@ -2112,12 +2105,12 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "STARTED", - "name": "STARTED" + "name": "STARTED", + "value": "STARTED" } ] } @@ -2392,40 +2385,40 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "NOT_READY", - "name": "NOT_READY" + "name": "NOT_READY", + "value": "NOT_READY" }, { - "value": "READY_FOR_TEST", - "name": "READY_FOR_TEST" + "name": "READY_FOR_TEST", + "value": "READY_FOR_TEST" }, { - "value": "TESTING", - "name": "TESTING" + "name": "TESTING", + "value": "TESTING" }, { - "value": "READY_FOR_CUTOVER", - "name": "READY_FOR_CUTOVER" + "name": "READY_FOR_CUTOVER", + "value": "READY_FOR_CUTOVER" }, { - "value": "CUTTING_OVER", - "name": "CUTTING_OVER" + "name": "CUTTING_OVER", + "value": "CUTTING_OVER" }, { - "value": "CUTOVER", - "name": "CUTOVER" + "name": "CUTOVER", + "value": "CUTOVER" }, { - "value": "DISCONNECTED", - "name": "DISCONNECTED" + "name": "DISCONNECTED", + "value": "DISCONNECTED" }, { - "value": "DISCOVERED", - "name": "DISCOVERED" + "name": "DISCOVERED", + "value": "DISCOVERED" } ] } @@ -2471,8 +2464,7 @@ "smithy.api#documentation": "

List all tags for your Application Migration Service resources.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -2523,8 +2515,8 @@ "traits": { "smithy.api#documentation": "

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

", "smithy.api#http": { - "method": "POST", "uri": "/MarkAsArchived", + "method": "POST", "code": 200 } } @@ -3008,10 +3000,7 @@ }, "traits": { "aws.api#arn": { - "template": "replication-configuration-template/{replicationConfigurationTemplateID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "replication-configuration-template/{replicationConfigurationTemplateID}" } } }, @@ -3038,12 +3027,12 @@ "traits": { "smithy.api#enum": [ { - "value": "AGENT_BASED", - "name": "AGENT_BASED" + "name": "AGENT_BASED", + "value": "AGENT_BASED" }, { - "value": "SNAPSHOT_SHIPPING", - "name": "SNAPSHOT_SHIPPING" + "name": "SNAPSHOT_SHIPPING", + "value": "SNAPSHOT_SHIPPING" } ] } @@ -3110,8 +3099,8 @@ "traits": { "smithy.api#documentation": "

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

", "smithy.api#http": { - "method": "POST", "uri": "/RetryDataReplication", + "method": "POST", "code": 200 } } @@ -3170,6 +3159,12 @@ "traits": { "smithy.api#documentation": "

Exceeded the service quota code.

" } + }, + "quotaValue": { + "target": "com.amazonaws.mgn#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "

Exceeded the service quota value.

" + } } }, "traits": { @@ -3386,10 +3381,7 @@ ], "traits": { "aws.api#arn": { - "template": "source-server/{sourceServerID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "source-server/{sourceServerID}" } } }, @@ -3421,8 +3413,8 @@ "traits": { "smithy.api#documentation": "

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

", "smithy.api#http": { - "method": "POST", "uri": "/StartCutover", + "method": "POST", "code": 202 } } @@ -3496,8 +3488,8 @@ "traits": { "smithy.api#documentation": "

Starts replication for SNAPSHOT_SHIPPING agents.

", "smithy.api#http": { - "method": "POST", "uri": "/StartReplication", + "method": "POST", "code": 200 } } @@ -3536,8 +3528,8 @@ "traits": { "smithy.api#documentation": "

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

", "smithy.api#http": { - "method": "POST", "uri": "/StartTest", + "method": "POST", "code": 202 } } @@ -3648,8 +3640,7 @@ "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -3700,12 +3691,12 @@ "traits": { "smithy.api#enum": [ { - "value": "NONE", - "name": "NONE" + "name": "NONE", + "value": "NONE" }, { - "value": "BASIC", - "name": "BASIC" + "name": "BASIC", + "value": "BASIC" } ] } @@ -3732,8 +3723,8 @@ "traits": { "smithy.api#documentation": "

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

", "smithy.api#http": { - "method": "POST", "uri": "/TerminateTargetInstances", + "method": "POST", "code": 202 } } @@ -3859,8 +3850,7 @@ "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of Application Migration Service resources.

", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -3911,8 +3901,8 @@ "traits": { "smithy.api#documentation": "

Updates multiple LaunchConfigurations by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateLaunchConfiguration", + "method": "POST", "code": 200 }, "smithy.api#idempotent": {} @@ -4000,8 +3990,8 @@ "traits": { "smithy.api#documentation": "

Allows you to update multiple ReplicationConfigurations by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateReplicationConfiguration", + "method": "POST", "code": 200 }, "smithy.api#idempotent": {} @@ -4128,8 +4118,8 @@ "traits": { "smithy.api#documentation": "

Updates multiple ReplicationConfigurationTemplates by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateReplicationConfigurationTemplate", + "method": "POST", "code": 200 } } @@ -4249,8 +4239,8 @@ "traits": { "smithy.api#documentation": "

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateSourceServerReplicationType", + "method": "POST", "code": 200 } } @@ -4438,10 +4428,7 @@ }, "traits": { "aws.api#arn": { - "template": "vcenter-client/{vcenterClientID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "vcenter-client/{vcenterClientID}" } } } diff --git a/codegen/sdk/aws-models/personalize.json b/codegen/sdk/aws-models/personalize.json index 27b34408db9..d83c69b6779 100644 --- a/codegen/sdk/aws-models/personalize.json +++ b/codegen/sdk/aws-models/personalize.json @@ -305,6 +305,12 @@ { "target": "com.amazonaws.personalize#ListTagsForResource" }, + { + "target": "com.amazonaws.personalize#StartRecommender" + }, + { + "target": "com.amazonaws.personalize#StopRecommender" + }, { "target": "com.amazonaws.personalize#StopSolutionVersionCreation" }, @@ -2871,6 +2877,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteCampaignRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -2904,6 +2913,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteDatasetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -2925,6 +2937,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteDatasetGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -2970,6 +2985,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteEventTrackerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3003,6 +3021,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteFilterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3035,6 +3056,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteRecommenderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3068,6 +3092,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteSchemaRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3101,6 +3128,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteSolutionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -6386,6 +6416,53 @@ } } }, + "com.amazonaws.personalize#StartRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#StartRecommenderRequest" + }, + "output": { + "target": "com.amazonaws.personalize#StartRecommenderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a recommender that is INACTIVE. Starting a recommender does not\n create any new models, but resumes billing and automatic retraining for the recommender.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#StartRecommenderRequest": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender to start.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#StartRecommenderResponse": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender you started.

" + } + } + } + }, "com.amazonaws.personalize#Status": { "type": "string", "traits": { @@ -6395,11 +6472,61 @@ } } }, + "com.amazonaws.personalize#StopRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#StopRecommenderRequest" + }, + "output": { + "target": "com.amazonaws.personalize#StopRecommenderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#StopRecommenderRequest": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender to stop.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#StopRecommenderResponse": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender you stopped.

" + } + } + } + }, "com.amazonaws.personalize#StopSolutionVersionCreation": { "type": "operation", "input": { "target": "com.amazonaws.personalize#StopSolutionVersionCreationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -6709,7 +6836,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a campaign by either deploying a new solution or changing the value of the\n campaign's minProvisionedTPS parameter.

\n

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the DescribeCampaign operation.

\n \n

You must wait until the status of the\n updated campaign is ACTIVE before asking the campaign for recommendations.

\n \n

For more information on campaigns, see CreateCampaign.

", + "smithy.api#documentation": "

Updates a campaign by either deploying a new solution or changing the value of the\n campaign's minProvisionedTPS parameter.

\n

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the DescribeCampaign operation.

\n\n \n

You can still get recommendations from a campaign while an update is in progress.\n The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.\n

\n \n \n

For more information on campaigns, see CreateCampaign.

", "smithy.api#idempotent": {} } }, diff --git a/codegen/sdk/aws-models/polly.json b/codegen/sdk/aws-models/polly.json index 4112e4878d0..75f282b23fd 100644 --- a/codegen/sdk/aws-models/polly.json +++ b/codegen/sdk/aws-models/polly.json @@ -558,6 +558,10 @@ { "value": "ca-ES", "name": "ca_ES" + }, + { + "value": "de-AT", + "name": "de_AT" } ] } @@ -1951,6 +1955,10 @@ { "value": "Arlet", "name": "Arlet" + }, + { + "value": "Hannah", + "name": "Hannah" } ] } diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index 9a44a1ad8d2..46309b7981c 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -127,6 +127,9 @@ "input": { "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -175,6 +178,9 @@ "input": { "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" @@ -274,6 +280,9 @@ "input": { "target": "com.amazonaws.rds#AddTagsToResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -378,9 +387,6 @@ { "target": "com.amazonaws.rds#CopyOptionGroup" }, - { - "target": "com.amazonaws.rds#CreateCustomAvailabilityZone" - }, { "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" }, @@ -429,9 +435,6 @@ { "target": "com.amazonaws.rds#CreateOptionGroup" }, - { - "target": "com.amazonaws.rds#DeleteCustomAvailabilityZone" - }, { "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" }, @@ -477,9 +480,6 @@ { "target": "com.amazonaws.rds#DeleteGlobalCluster" }, - { - "target": "com.amazonaws.rds#DeleteInstallationMedia" - }, { "target": "com.amazonaws.rds#DeleteOptionGroup" }, @@ -492,9 +492,6 @@ { "target": "com.amazonaws.rds#DescribeCertificates" }, - { - "target": "com.amazonaws.rds#DescribeCustomAvailabilityZones" - }, { "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" }, @@ -579,9 +576,6 @@ { "target": "com.amazonaws.rds#DescribeGlobalClusters" }, - { - "target": "com.amazonaws.rds#DescribeInstallationMedia" - }, { "target": "com.amazonaws.rds#DescribeOptionGroupOptions" }, @@ -615,9 +609,6 @@ { "target": "com.amazonaws.rds#FailoverGlobalCluster" }, - { - "target": "com.amazonaws.rds#ImportInstallationMedia" - }, { "target": "com.amazonaws.rds#ListTagsForResource" }, @@ -1816,70 +1807,6 @@ } } }, - "com.amazonaws.rds#CreateCustomAvailabilityZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateCustomAvailabilityZoneResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, - "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the custom Availability Zone (AZ).

", - "smithy.api#required": {} - } - }, - "ExistingVpnId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of an existing virtual private network (VPN) between the Amazon RDS website and\n the VMware vSphere cluster.

" - } - }, - "NewVpnTunnelName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

\n

Specify this parameter only if ExistingVpnId isn't specified.

" - } - }, - "VpnTunnelOriginatorIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

\n

Specify this parameter only if ExistingVpnId isn't specified.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateCustomAvailabilityZoneResult": { - "type": "structure", - "members": { - "CustomAvailabilityZone": { - "target": "com.amazonaws.rds#CustomAvailabilityZone" - } - } - }, "com.amazonaws.rds#CreateCustomDBEngineVersion": { "type": "operation", "input": { @@ -2370,6 +2297,9 @@ "traits": { "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

Valid for: Multi-AZ DB clusters only

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -2646,7 +2576,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Not applicable. Availability Zones are managed by the DB cluster.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n " + "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n " } }, "DBSubnetGroupName": { @@ -3864,81 +3794,6 @@ } } }, - "com.amazonaws.rds#CustomAvailabilityZone": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the custom AZ.

\n

Amazon RDS generates a unique identifier when a custom AZ is created.

" - } - }, - "CustomAvailabilityZoneName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the custom AZ.

" - } - }, - "CustomAvailabilityZoneStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the custom AZ.

" - } - }, - "VpnDetails": { - "target": "com.amazonaws.rds#VpnDetails", - "traits": { - "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster\n and the Amazon Web Services website.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomAvailabilityZoneAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n CustomAvailabilityZoneName is already used by an existing custom\n Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#CustomAvailabilityZone", - "traits": { - "smithy.api#xmlName": "CustomAvailabilityZone" - } - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCustomAvailabilityZones request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "CustomAvailabilityZones": { - "target": "com.amazonaws.rds#CustomAvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The list of CustomAvailabilityZone objects for the Amazon Web Services account.

" - } - } - } - }, "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { "type": "structure", "members": { @@ -3956,23 +3811,6 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.rds#CustomAvailabilityZoneQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomAvailabilityZoneQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded the maximum number of custom Availability Zones.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { "type": "structure", "members": { @@ -4471,6 +4309,9 @@ "traits": { "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" } }, "traits": { @@ -7869,46 +7710,6 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.rds#DeleteCustomAvailabilityZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteCustomAvailabilityZoneMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteCustomAvailabilityZoneResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, - "com.amazonaws.rds#DeleteCustomAvailabilityZoneMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The custom AZ identifier.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#DeleteCustomAvailabilityZoneResult": { - "type": "structure", - "members": { - "CustomAvailabilityZone": { - "target": "com.amazonaws.rds#CustomAvailabilityZone" - } - } - }, "com.amazonaws.rds#DeleteCustomDBEngineVersion": { "type": "operation", "input": { @@ -8044,6 +7845,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" @@ -8248,6 +8052,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" @@ -8366,6 +8173,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" @@ -8441,6 +8251,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" @@ -8554,40 +8367,14 @@ } } }, - "com.amazonaws.rds#DeleteInstallationMedia": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteInstallationMediaMessage" - }, - "output": { - "target": "com.amazonaws.rds#InstallationMedia" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InstallationMediaNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the installation medium for a DB engine that requires an on-premises customer provided license,\n such as Microsoft SQL Server.

" - } - }, - "com.amazonaws.rds#DeleteInstallationMediaMessage": { - "type": "structure", - "members": { - "InstallationMediaId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The installation medium ID.

", - "smithy.api#required": {} - } - } - } - }, "com.amazonaws.rds#DeleteOptionGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteOptionGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" @@ -8749,58 +8536,6 @@ "smithy.api#documentation": "

" } }, - "com.amazonaws.rds#DescribeCustomAvailabilityZones": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeCustomAvailabilityZonesMessage" - }, - "output": { - "target": "com.amazonaws.rds#CustomAvailabilityZoneMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about custom Availability Zones (AZs).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "CustomAvailabilityZones", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeCustomAvailabilityZonesMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more custom AZs to describe.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCustomAvailabilityZones request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, "com.amazonaws.rds#DescribeDBClusterBacktracks": { "type": "operation", "input": { @@ -10685,7 +10420,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family.

", + "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -10997,58 +10732,6 @@ } } }, - "com.amazonaws.rds#DescribeInstallationMedia": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeInstallationMediaMessage" - }, - "output": { - "target": "com.amazonaws.rds#InstallationMediaMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InstallationMediaNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available installation media for a DB engine that requires an \n on-premises customer provided license, such as Microsoft SQL Server.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "InstallationMedia", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeInstallationMediaMessage": { - "type": "structure", - "members": { - "InstallationMediaId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The installation medium ID.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more installation media to describe. Supported filters\n include the following:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, "com.amazonaws.rds#DescribeOptionGroupOptions": { "type": "operation", "input": { @@ -12765,196 +12448,6 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.rds#ImportInstallationMedia": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ImportInstallationMediaMessage" - }, - "output": { - "target": "com.amazonaws.rds#InstallationMedia" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstallationMediaAlreadyExistsFault" - } - ], - "traits": { - "smithy.api#documentation": "

Imports the installation media for a DB engine that requires an on-premises \n customer provided license, such as SQL Server.

" - } - }, - "com.amazonaws.rds#ImportInstallationMediaMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the custom Availability Zone (AZ) to import the installation media to.

", - "smithy.api#required": {} - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

The list only includes supported DB engines that require an on-premises \n customer provided license.

\n

Valid Values:

\n ", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, call DescribeDBEngineVersions.

\n

The following are the database engines and links to information about the major and minor \n versions. The list only includes DB engines that require an on-premises \n customer provided license.

\n

\n Microsoft SQL Server\n

\n

See \n Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

", - "smithy.api#required": {} - } - }, - "EngineInstallationMediaPath": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The path to the installation medium for the specified DB engine.

\n

Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso\n

", - "smithy.api#required": {} - } - }, - "OSInstallationMediaPath": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The path to the installation medium for the operating system associated with the specified DB engine.

\n

Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso\n

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#InstallationMedia": { - "type": "structure", - "members": { - "InstallationMediaId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The installation medium ID.

" - } - }, - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The custom Availability Zone (AZ) that contains the installation media.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version of the DB engine.

" - } - }, - "EngineInstallationMediaPath": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The path to the installation medium for the DB engine.

" - } - }, - "OSInstallationMediaPath": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The path to the installation medium for the operating system associated with the DB engine.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the installation medium.

" - } - }, - "FailureCause": { - "target": "com.amazonaws.rds#InstallationMediaFailureCause", - "traits": { - "smithy.api#documentation": "

If an installation media failure occurred, the cause of the failure.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the installation media for a DB engine that requires an on-premises \n customer provided license, such as Microsoft SQL Server.

" - } - }, - "com.amazonaws.rds#InstallationMediaAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InstallationMediaAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified installation medium has already been imported.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InstallationMediaFailureCause": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reason that an installation media import failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the cause of an installation media failure. Installation media is used \n for a DB engine that requires an on-premises \n customer provided license, such as Microsoft SQL Server.

" - } - }, - "com.amazonaws.rds#InstallationMediaList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#InstallationMedia", - "traits": { - "smithy.api#xmlName": "InstallationMedia" - } - } - }, - "com.amazonaws.rds#InstallationMediaMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "InstallationMedia": { - "target": "com.amazonaws.rds#InstallationMediaList", - "traits": { - "smithy.api#documentation": "

The list of InstallationMedia objects for the Amazon Web Services account.

" - } - } - } - }, - "com.amazonaws.rds#InstallationMediaNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InstallationMediaNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n InstallationMediaID doesn't refer to an existing installation medium.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, "com.amazonaws.rds#InstanceQuotaExceededFault": { "type": "structure", "members": { @@ -13625,7 +13118,7 @@ } ], "traits": { - "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances temporarily, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ModifyCertificatesMessage": { @@ -14073,6 +13566,9 @@ "traits": { "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

Valid for: Multi-AZ DB clusters only

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -16898,6 +16394,9 @@ "input": { "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -16943,6 +16442,9 @@ "input": { "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" @@ -17039,6 +16541,9 @@ "input": { "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -17775,6 +17280,9 @@ "traits": { "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } } }, @@ -18012,6 +17520,9 @@ "traits": { "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -18245,6 +17756,9 @@ "traits": { "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -19422,6 +18936,46 @@ "smithy.api#documentation": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" } }, + "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { "type": "structure", "members": { @@ -20224,12 +19778,6 @@ "target": "com.amazonaws.rds#String" } }, - "com.amazonaws.rds#StringSensitive": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, "com.amazonaws.rds#Subnet": { "type": "structure", "members": { @@ -20812,50 +20360,6 @@ } } }, - "com.amazonaws.rds#VpnDetails": { - "type": "structure", - "members": { - "VpnId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPN.

" - } - }, - "VpnTunnelOriginatorIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

" - } - }, - "VpnGatewayIp": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The IP address of network traffic from Amazon Web Services to your on-premises data center.

" - } - }, - "VpnPSK": { - "target": "com.amazonaws.rds#StringSensitive", - "traits": { - "smithy.api#documentation": "

The preshared key (PSK) for the VPN.

" - } - }, - "VpnName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the VPN.

" - } - }, - "VpnState": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The state of the VPN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, "com.amazonaws.rds#WriteForwardingStatus": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/redshift.json b/codegen/sdk/aws-models/redshift.json index c2781befee5..c9d6a84f6f9 100644 --- a/codegen/sdk/aws-models/redshift.json +++ b/codegen/sdk/aws-models/redshift.json @@ -3554,6 +3554,9 @@ "input": { "target": "com.amazonaws.redshift#CreateTagsMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidClusterStateFault" @@ -4115,6 +4118,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteClusterParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterParameterGroupNotFoundFault" @@ -4155,6 +4161,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteClusterSecurityGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterSecurityGroupNotFoundFault" @@ -4245,6 +4254,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteClusterSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterSubnetGroupNotFoundFault" @@ -4321,6 +4333,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteEventSubscriptionMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidSubscriptionStateFault" @@ -4353,6 +4368,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteHsmClientCertificateMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#HsmClientCertificateNotFoundFault" @@ -4385,6 +4403,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteHsmConfigurationMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#HsmConfigurationNotFoundFault" @@ -4440,6 +4461,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteScheduledActionMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ScheduledActionNotFoundFault" @@ -4469,6 +4493,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteSnapshotCopyGrantMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidSnapshotCopyGrantStateFault" @@ -4501,6 +4528,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteSnapshotScheduleMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidClusterSnapshotScheduleStateFault" @@ -4530,6 +4560,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteTagsMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidTagFault" @@ -4569,6 +4602,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteUsageLimitMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#UnsupportedOperationFault" @@ -6724,6 +6760,9 @@ }, "com.amazonaws.redshift#DescribeStorage": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.redshift#CustomerStorageMessage" }, @@ -7190,8 +7229,7 @@ "BucketName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The name of an existing S3 bucket where the log files are to be stored.

\n

Constraints:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of an existing S3 bucket where the log files are to be stored.

\n

Constraints:

\n " } }, "S3KeyPrefix": { @@ -7199,6 +7237,18 @@ "traits": { "smithy.api#documentation": "

The prefix applied to the log file names.

\n

Constraints:

\n " } + }, + "LogDestinationType": { + "target": "com.amazonaws.redshift#LogDestinationType", + "traits": { + "smithy.api#documentation": "

The log destination type. An enum with possible values of s3 and cloudwatch.

" + } + }, + "LogExports": { + "target": "com.amazonaws.redshift#LogTypeList", + "traits": { + "smithy.api#documentation": "

The collection of exported log types. Log types include the connection log, user log and user activity log.

" + } } }, "traits": { @@ -9074,6 +9124,27 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#LogDestinationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "s3", + "name": "S3" + }, + { + "value": "cloudwatch", + "name": "CLOUDWATCH" + } + ] + } + }, + "com.amazonaws.redshift#LogTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#String" + } + }, "com.amazonaws.redshift#LoggingStatus": { "type": "structure", "members": { @@ -9112,6 +9183,18 @@ "traits": { "smithy.api#documentation": "

The message indicating that logs failed to be delivered.

" } + }, + "LogDestinationType": { + "target": "com.amazonaws.redshift#LogDestinationType", + "traits": { + "smithy.api#documentation": "

The log destination type. An enum with possible values of s3 and cloudwatch.

" + } + }, + "LogExports": { + "target": "com.amazonaws.redshift#LogTypeList", + "traits": { + "smithy.api#documentation": "

The collection of exported log types. Log types include the connection log, user log and user activity log.

" + } } }, "traits": { @@ -9800,6 +9883,9 @@ "input": { "target": "com.amazonaws.redshift#ModifyClusterSnapshotScheduleMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterNotFoundFault" @@ -12554,7 +12640,7 @@ "KmsKeyId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The Key Management Service (KMS) key ID of the encryption key to encrypt data in the cluster \n restored from a shared snapshot. You can also provide \n the key ID when you restore from an unencrypted snapshot to an encrypted cluster in \n the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted \n snapshot in the same account in order to change it. In that case, the restored cluster is encrypted \n with the new KMS key ID.

" + "smithy.api#documentation": "

The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster \n restored from a shared snapshot. You can also provide \n the key ID when you restore from an unencrypted snapshot to an encrypted cluster in \n the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted \n snapshot in the same account in order to change it. In that case, the restored cluster is encrypted \n with the new KMS key ID.

" } }, "NodeType": { @@ -12632,7 +12718,7 @@ "Encrypted": { "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

Enables support for restoring an unencrypted snapshot to a cluster encrypted \n with Key Management Service (KMS) and a CMK.

" + "smithy.api#documentation": "

Enables support for restoring an unencrypted snapshot to a cluster encrypted \n with Key Management Service (KMS) and a customer managed key.

" } } }, diff --git a/codegen/sdk/aws-models/secrets-manager.json b/codegen/sdk/aws-models/secrets-manager.json index 3f0024bce5c..3fc31db8b23 100644 --- a/codegen/sdk/aws-models/secrets-manager.json +++ b/codegen/sdk/aws-models/secrets-manager.json @@ -75,7 +75,7 @@ } ], "traits": { - "smithy.api#documentation": "

Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.

\n

To turn on automatic rotation again, call RotateSecret.

\n \n

If you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label AWSPENDING from the partially created version, specified\n by the VersionId response value. We recommend you also evaluate the partially rotated\n new version to see if it should be deleted. You can delete a version by removing all staging labels\n from it.

\n \n

\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.

\n

To turn on automatic rotation again, call RotateSecret.

\n \n

If you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label AWSPENDING from the partially created version, specified\n by the VersionId response value. We recommend you also evaluate the partially rotated\n new version to see if it should be deleted. You can delete a version by removing all staging labels\n from it.

\n \n

\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#CancelRotateSecretRequest": { @@ -84,7 +84,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -163,7 +163,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new secret. A secret is a set of credentials, such as a \n user name and password, that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.

\n

For information about creating a secret in the console, see Create a secret.

\n

To create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but not both. \n If you include SecretString or SecretBinary\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to it.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. \n Creating aws/secretsmanager can result in a one-time significant delay in returning the \n result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.

\n

\n Required permissions: \n secretsmanager:CreateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Creates a new secret. A secret can be a password, a set of \n credentials such as a user name and password, an OAuth token, or other secret information \n that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.

\n

For information about creating a secret in the console, see Create a secret.

\n

To create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but not both. \n If you include SecretString or SecretBinary\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to it.

\n

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,\n you must make sure the JSON you store in the SecretString matches the JSON structure of\n a database secret.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. \n Creating aws/secretsmanager can result in a one-time significant delay in returning the \n result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.

\n

\n Required permissions: \n secretsmanager:CreateSecret. If you \n include tags in the secret, you also need secretsmanager:TagResource.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

\n

To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.

" } }, "com.amazonaws.secretsmanager#CreateSecretRequest": { @@ -294,7 +294,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.

\n

\n Required permissions: \n secretsmanager:DeleteResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.

\n

\n Required permissions: \n secretsmanager:DeleteResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest": { @@ -303,7 +303,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to delete the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to delete the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -349,7 +349,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.

\n

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.

\n

At any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.

\n

In a secret scheduled for deletion, you cannot access the encrypted secret value.\n To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.

\n

\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Deletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.

\n

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.

\n

At any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.

\n

In a secret scheduled for deletion, you cannot access the encrypted secret value.\n To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.

\n

\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DeleteSecretRequest": { @@ -358,7 +358,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to delete.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to delete.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -427,7 +427,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.

\n

\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.

\n

\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DescribeSecretRequest": { @@ -436,7 +436,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -710,7 +710,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.

\n

\n Required permissions: \n secretsmanager:GetRandomPassword. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Generates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.

\n

\n Required permissions: \n secretsmanager:GetRandomPassword. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#GetRandomPasswordRequest": { @@ -807,7 +807,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the\n secret. For more information about permissions policies attached to a secret, see \n Permissions \n policies attached to a secret.

\n

\n Required permissions: \n secretsmanager:GetResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the\n secret. For more information about permissions policies attached to a secret, see \n Permissions \n policies attached to a secret.

\n

\n Required permissions: \n secretsmanager:GetResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#GetResourcePolicyRequest": { @@ -816,7 +816,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to retrieve the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to retrieve the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -871,7 +871,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.

\n \n

\n Required permissions: \n secretsmanager:GetSecretValue. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.

\n \n

\n Required permissions: \n secretsmanager:GetSecretValue. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#GetSecretValueRequest": { @@ -880,7 +880,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to retrieve.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to retrieve.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -1055,7 +1055,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the versions for a secret.

\n

To list the secrets in the account, use ListSecrets.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

\n Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", + "smithy.api#documentation": "

Lists the versions for a secret.

\n

To list the secrets in the account, use ListSecrets.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

\n Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1069,7 +1069,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret whose versions you want to list.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret whose versions you want to list.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -1144,7 +1144,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", + "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1318,7 +1318,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see Authentication and access control for Secrets Manager\n

\n

For information about attaching a policy in the console, see Attach a \n permissions policy to a secret.

\n

\n Required permissions: \n secretsmanager:PutResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Attaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see Authentication and access control for Secrets Manager\n

\n

For information about attaching a policy in the console, see Attach a \n permissions policy to a secret.

\n

\n Required permissions: \n secretsmanager:PutResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#PutResourcePolicyRequest": { @@ -1327,7 +1327,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to attach the resource-based policy.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to attach the resource-based policy.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -1399,7 +1399,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.

\n

We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it .

\n

If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.

\n

This operation is idempotent. If a version with a VersionId with the same\n value as the ClientRequestToken parameter already exists, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.

\n

\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.

\n

We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it .

\n

If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.

\n

This operation is idempotent. If a version with a VersionId with the same\n value as the ClientRequestToken parameter already exists, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.

\n

\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#PutSecretValueRequest": { @@ -1408,7 +1408,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to add a new version to.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

\n

If the secret doesn't already exist, use CreateSecret instead.

", + "smithy.api#documentation": "

The ARN or name of the secret to add a new version to.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

\n

If the secret doesn't already exist, use CreateSecret instead.

", "smithy.api#required": {} } }, @@ -1514,7 +1514,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

\n

\n Required permissions: \n secretsmanager:RemoveRegionsFromReplication. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

\n

\n Required permissions: \n secretsmanager:RemoveRegionsFromReplication. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest": { @@ -1607,7 +1607,7 @@ } ], "traits": { - "smithy.api#documentation": "

Replicates the secret to a new Regions. See Multi-Region secrets.

\n

\n Required permissions: \n secretsmanager:ReplicateSecretToRegions. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Replicates the secret to a new Regions. See Multi-Region secrets.

\n

\n Required permissions: \n secretsmanager:ReplicateSecretToRegions. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest": { @@ -1746,7 +1746,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. You can access a secret again after it has been restored.

\n

\n Required permissions: \n secretsmanager:RestoreSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Cancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. You can access a secret again after it has been restored.

\n

\n Required permissions: \n secretsmanager:RestoreSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#RestoreSecretRequest": { @@ -1755,7 +1755,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to restore.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to restore.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -1801,7 +1801,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures and starts the asynchronous process of rotating the secret.

\n

If you include the\n configuration parameters, the operation sets the values for the secret and then immediately\n starts a rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret. For more information about rotation, \n see Rotate secrets.

\n

To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule \n for the rotation. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the database or service to\n match. After testing the new credentials, the function marks the new secret version with the staging\n label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more\n information, see How rotation works.

\n

When rotation is successful, the AWSPENDING staging label might be attached to the same \n version as the AWSCURRENT version, or it might not be attached to any version.

\n

If the AWSPENDING staging label is present but not attached to the same version as\n AWSCURRENT, then any later invocation of RotateSecret assumes that a previous\n rotation request is still in progress and returns an error.

\n

\n Required permissions: \n secretsmanager:RotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. \n For more information, see \n Permissions for rotation.

" + "smithy.api#documentation": "

Configures and starts the asynchronous process of rotating the secret. For more information about rotation, \n see Rotate secrets.

\n

If you include the\n configuration parameters, the operation sets the values for the secret and then immediately\n starts a rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret.

\n

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must \n make sure the secret value is in the\n JSON structure\n of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser\n secret.

\n \n

To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule \n for the rotation. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the database or service to\n match. After testing the new credentials, the function marks the new secret version with the staging\n label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more\n information, see How rotation works.

\n

You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose \n a template that matches your Rotation strategy.

\n

When rotation is successful, the AWSPENDING staging label might be attached\n to the same version as the AWSCURRENT version, or it might not be attached to any\n version. If the AWSPENDING staging label is present but not attached to the same\n version as AWSCURRENT, then any later invocation of RotateSecret\n assumes that a previous rotation request is still in progress and returns an error.

\n

\n Required permissions: \n secretsmanager:RotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. \n For more information, see \n Permissions for rotation.

" } }, "com.amazonaws.secretsmanager#RotateSecretRequest": { @@ -1810,7 +1810,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret to rotate.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to rotate.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2221,7 +2221,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

\n

You must call this operation from the Region in which you want to promote the replica to a primary secret.

\n

\n Required permissions: \n secretsmanager:StopReplicationToReplica. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

\n

You must call this operation from the Region in which you want to promote the replica to a primary secret.

\n

\n Required permissions: \n secretsmanager:StopReplicationToReplica. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest": { @@ -2293,6 +2293,9 @@ "input": { "target": "com.amazonaws.secretsmanager#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" @@ -2308,7 +2311,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the \n secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

\n

The following restrictions apply to tags:

\n \n \n \n

If you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n \n

\n Required permissions: \n secretsmanager:TagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the \n secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

\n

The following restrictions apply to tags:

\n \n \n \n

If you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n \n

\n Required permissions: \n secretsmanager:TagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#TagResourceRequest": { @@ -2317,7 +2320,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The identifier for the secret to attach tags to. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The identifier for the secret to attach tags to. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2347,6 +2350,9 @@ "input": { "target": "com.amazonaws.secretsmanager#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" @@ -2362,7 +2368,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes specific tags from a secret.

\n

This operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.

\n \n

If you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n \n

\n Required permissions: \n secretsmanager:UntagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Removes specific tags from a secret.

\n

This operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.

\n \n

If you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n \n

\n Required permissions: \n secretsmanager:UntagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#UntagResourceRequest": { @@ -2371,7 +2377,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2425,7 +2431,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

\n

If you call this operation with a VersionId that matches an existing version's \n ClientRequestToken, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key.

\n

\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" + "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

\n

If you call this operation with a VersionId that matches an existing version's \n ClientRequestToken, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key.

\n

\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" } }, "com.amazonaws.secretsmanager#UpdateSecretRequest": { @@ -2434,7 +2440,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2520,7 +2526,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to\n track a version as it progresses through the secret rotation process. Each staging label can be \n attached to only one version at a time. To add a staging label to a version when it is already \n attached to another version, Secrets Manager first removes it from the other version first and\n then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

\n

The staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels for the version.

\n

You can move the AWSCURRENT staging label to this version by including it in this\n call.

\n \n

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.

\n \n

If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.

\n

\n Required permissions: \n secretsmanager:UpdateSecretVersionStage. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to\n track a version as it progresses through the secret rotation process. Each staging label can be \n attached to only one version at a time. To add a staging label to a version when it is already \n attached to another version, Secrets Manager first removes it from the other version first and\n then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

\n

The staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels for the version.

\n

You can move the AWSCURRENT staging label to this version by including it in this\n call.

\n \n

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.

\n \n

If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.

\n

\n Required permissions: \n secretsmanager:UpdateSecretVersionStage. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest": { @@ -2529,7 +2535,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The ARN or the name of the secret with the version and staging labelsto modify.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or the name of the secret with the version and staging labelsto modify.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2597,7 +2603,7 @@ } ], "traits": { - "smithy.api#documentation": "

Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.

\n

The API performs three checks when validating the policy:

\n \n

\n Required permissions: \n secretsmanager:ValidateResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.

\n

The API performs three checks when validating the policy:

\n \n

\n Required permissions: \n secretsmanager:ValidateResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest": { diff --git a/codegen/sdk/aws-models/ssm.json b/codegen/sdk/aws-models/ssm.json index 37b04f7060c..68d0fd8d235 100644 --- a/codegen/sdk/aws-models/ssm.json +++ b/codegen/sdk/aws-models/ssm.json @@ -221,7 +221,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your documents, managed nodes, maintenance windows, Parameter Store parameters, and\n patch baselines. Tags enable you to categorize your resources in different ways, for example, by\n purpose, owner, or environment. Each tag consists of a key and an optional value, both of which\n you define. For example, you could define a set of tags for your account's managed nodes that\n helps you track each node's owner and stack level. For example:

\n \n

Each resource can have a maximum of 50 tags.

\n

We recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.

\n

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and\n patch baselines. Tags enable you to categorize your resources in different ways, for example, by\n purpose, owner, or environment. Each tag consists of a key and an optional value, both of which\n you define. For example, you could define a set of tags for your account's managed nodes that\n helps you track each node's owner and stack level. For example:

\n \n

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

\n

We recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.

\n

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ssm#AddTagsToResourceRequest": { @@ -237,7 +237,7 @@ "ResourceId": { "target": "com.amazonaws.ssm#ResourceId", "traits": { - "smithy.api#documentation": "

The resource ID you want to tag.

\n

Use the ID of the resource. Here are some examples:

\n

\n MaintenanceWindow: mw-012345abcde\n

\n

\n PatchBaseline: pb-012345abcde\n

\n

\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the\n resource.

\n

\n ManagedInstance: mi-012345abcde\n

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.

\n ", + "smithy.api#documentation": "

The resource ID you want to tag.

\n

Use the ID of the resource. Here are some examples:

\n

\n MaintenanceWindow: mw-012345abcde\n

\n

\n PatchBaseline: pb-012345abcde\n

\n

\n Automation: example-c160-4567-8519-012345abcde\n

\n

\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the\n resource.

\n

\n ManagedInstance: mi-012345abcde\n

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.

\n ", "smithy.api#required": {} } }, @@ -879,6 +879,13 @@ "traits": { "smithy.api#documentation": "

The association name.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -1070,6 +1077,13 @@ "traits": { "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -1771,6 +1785,13 @@ "traits": { "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association\n when this association version was created.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -4445,6 +4466,13 @@ "traits": { "smithy.api#documentation": "

Use this action to create an association in multiple Regions and multiple accounts.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -4567,6 +4595,13 @@ "traits": { "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to create an association in multiple Regions and multiple\n accounts.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " + } } } }, @@ -21506,7 +21541,7 @@ "ResourceId": { "target": "com.amazonaws.ssm#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the resource from which you want to remove tags. For example:

\n

ManagedInstance: mi-012345abcde

\n

MaintenanceWindow: mw-012345abcde

\n

PatchBaseline: pb-012345abcde

\n

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, ResourceID is created from the strings that\n come after the word opsmetadata in the ARN. For example, an OpsMetadata object with\n an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager\n has a ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the resource.

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For\n example, mi-1a2b3c4d5e6f.

\n ", + "smithy.api#documentation": "

The ID of the resource from which you want to remove tags. For example:

\n

ManagedInstance: mi-012345abcde

\n

MaintenanceWindow: mw-012345abcde

\n

\n Automation: example-c160-4567-8519-012345abcde\n

\n

PatchBaseline: pb-012345abcde

\n

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, ResourceID is created from the strings that\n come after the word opsmetadata in the ARN. For example, an OpsMetadata object with\n an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager\n has a ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the resource.

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For\n example, mi-1a2b3c4d5e6f.

\n ", "smithy.api#required": {} } }, @@ -22556,6 +22591,15 @@ } } }, + "com.amazonaws.ssm#ScheduleOffset": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 6 + } + } + }, "com.amazonaws.ssm#ScheduledWindowExecution": { "type": "structure", "members": { @@ -23503,7 +23547,7 @@ "Tags": { "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an automation. Tags enable you to categorize a resource in different ways, such as by purpose,\n owner, or environment. For example, you might want to tag an automation to identify an\n environment or operating system. In this case, you could specify the following key-value\n pairs:

\n \n \n

To add tags to an existing patch baseline, use the AddTagsToResource\n operation.

\n " + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an automation. Tags enable you to categorize a resource in different ways, such as by purpose,\n owner, or environment. For example, you might want to tag an automation to identify an\n environment or operating system. In this case, you could specify the following key-value\n pairs:

\n \n \n

To add tags to an existing automation, use the AddTagsToResource\n operation.

\n " } } } @@ -24806,6 +24850,13 @@ "traits": { "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to update an association in multiple Regions and multiple\n accounts.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " + } } } }, diff --git a/codegen/sdk/aws-models/storage-gateway.json b/codegen/sdk/aws-models/storage-gateway.json index 2d6e6163f7c..2aa4cbe2d13 100644 --- a/codegen/sdk/aws-models/storage-gateway.json +++ b/codegen/sdk/aws-models/storage-gateway.json @@ -381,7 +381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in\n the S3 storage class that is associated with the pool. When you use your backup application\n to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or\n S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in\n the S3 storage class that is associated with the pool. When you use your backup application\n to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or\n S3 Glacier Deep Archive) that corresponds to the pool.

" } }, "com.amazonaws.storagegateway#AssignTapePoolInput": { @@ -397,7 +397,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

", + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

", "smithy.api#required": {} } }, @@ -647,7 +647,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool.\n When you use your backup application to eject the tape, the tape is archived directly into\n the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the\n pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

", + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool.\n When you use your backup application to eject the tape, the tape is archived directly into\n the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the\n pool.

", "smithy.api#required": {} } }, @@ -896,7 +896,7 @@ "VolumeUsedInBytes": { "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", "traits": { - "smithy.api#documentation": "

The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.

\n\n \n

This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

\n " + "smithy.api#documentation": "

The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.

\n\n \n

This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

\n\n

If you use a delete tool that overwrites the data on your volume with random data,\n your usage will not be reduced. This is because the random data is not compressible. If\n you want to reduce the amount of billed storage on your volume, we recommend overwriting\n your files with zeros to compress the data to a negligible amount of actual\n storage.

\n " } }, "KMSKey": { @@ -1288,7 +1288,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -1454,7 +1454,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -1971,7 +1971,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

" } }, "Worm": { @@ -2078,7 +2078,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

" } }, "Worm": { @@ -2427,7 +2427,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a snapshot of a volume.

\n\n

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API\n action enables you to delete a snapshot schedule for a volume. For more information, see\n Backing up your\n volumes. In the DeleteSnapshotSchedule request, you identify the\n volume by providing its Amazon Resource Name (ARN). This operation is only supported in\n stored and cached volume gateway types.

\n\n \n\n

To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to DescribeSnapshots\n in the Amazon Elastic Compute Cloud API Reference.

\n " + "smithy.api#documentation": "

Deletes a snapshot of a volume.

\n\n

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API\n action enables you to delete a snapshot schedule for a volume. For more information, see\n Backing up your\n volumes. In the DeleteSnapshotSchedule request, you identify the\n volume by providing its Amazon Resource Name (ARN). This operation is only supported for\n cached volume gateway types.

\n\n \n\n

To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to DescribeSnapshots\n in the Amazon Elastic Compute Cloud API Reference.

\n " } }, "com.amazonaws.storagegateway#DeleteSnapshotScheduleInput": { @@ -3122,7 +3122,7 @@ "LastSoftwareUpdate": { "target": "com.amazonaws.storagegateway#LastSoftwareUpdate", "traits": { - "smithy.api#documentation": "

The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response.

" + "smithy.api#documentation": "

The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response. This only only\n exist and returns once it have been chosen and set by the SGW service, based on the OS\n version of the gateway VM

" } }, "Ec2InstanceId": { @@ -3152,7 +3152,7 @@ "CloudWatchLogGroupARN": { "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway. This field only only exist and returns once it have been\n chosen and set by the SGW service, based on the OS version of the gateway VM

" } }, "HostEnvironment": { @@ -6162,7 +6162,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -6323,7 +6323,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to Amazon S3.

\n\n

Storage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

\n\n \n\n

For more information, see Getting file upload notification in the Storage Gateway User\n Guide.

" + "smithy.api#documentation": "

Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.

\n\n

Storage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

\n\n \n\n

For more information, see Getting file upload notification in the Storage Gateway User\n Guide.

" } }, "com.amazonaws.storagegateway#NotifyWhenUploadedInput": { @@ -6564,7 +6564,7 @@ } ], "traits": { - "smithy.api#documentation": "

Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.

\n

You can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.

\n\n

When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.

\n\n

Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

\n\n

If you invoke the RefreshCache API when two requests are already being processed, any\n new request will cause an InvalidGatewayRequestException error because too\n many requests were sent to the server.

\n\n \n\n

For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

" + "smithy.api#documentation": "

Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.

\n\n

You can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.

\n\n

When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.

\n\n

Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

\n\n \n \n \n\n \n

The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.

\n \n\n \n\n

For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

" } }, "com.amazonaws.storagegateway#RefreshCacheInput": { @@ -6911,7 +6911,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -7902,7 +7902,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

" } }, "Worm": { @@ -7935,7 +7935,7 @@ "min": 50, "max": 500 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{7,16}$" + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" } }, "com.amazonaws.storagegateway#TapeARNs": { @@ -8004,7 +8004,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.

" } }, "Worm": { @@ -8043,7 +8043,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 7, + "min": 5, "max": 16 }, "smithy.api#pattern": "^[A-Z0-9]*$" @@ -8104,7 +8104,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

" } }, "RetentionStartDate": { @@ -8766,7 +8766,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -8893,7 +8893,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { diff --git a/codegen/sdk/aws-models/textract.json b/codegen/sdk/aws-models/textract.json index 53b0fc49b70..f1ee55b2002 100644 --- a/codegen/sdk/aws-models/textract.json +++ b/codegen/sdk/aws-models/textract.json @@ -85,7 +85,7 @@ } ], "traits": { - "smithy.api#documentation": "

Analyzes an input document for relationships between detected items.

\n

The types of information returned are as follows:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n

You can choose which type of analysis to perform by specifying the FeatureTypes list. \n

\n

The output is returned in a list of Block objects.

\n

\n AnalyzeDocument is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" + "smithy.api#documentation": "

Analyzes an input document for relationships between detected items.

\n

The types of information returned are as follows:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n \n

You can choose which type of analysis to perform by specifying the FeatureTypes list. \n

\n

The output is returned in a list of Block objects.

\n

\n AnalyzeDocument is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" } }, "com.amazonaws.textract#AnalyzeDocumentRequest": { @@ -94,7 +94,7 @@ "Document": { "target": "com.amazonaws.textract#Document", "traits": { - "smithy.api#documentation": "

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG or PNG format.

\n

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.

", + "smithy.api#documentation": "

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG, PNG, PDF, or TIFF format.

\n

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.

", "smithy.api#required": {} } }, @@ -110,6 +110,12 @@ "traits": { "smithy.api#documentation": "

Sets the configuration for the human in the loop workflow for analyzing documents.

" } + }, + "QueriesConfig": { + "target": "com.amazonaws.textract#QueriesConfig", + "traits": { + "smithy.api#documentation": "

Contains Queries and the alias for those Queries, as determined by the input.

" + } } } }, @@ -246,7 +252,7 @@ } ], "traits": { - "smithy.api#documentation": "

Analyzes identity documents for relevant information. This information is extracted\n and returned as IdentityDocumentFields, which records both the normalized\n field and value of the extracted text.

" + "smithy.api#documentation": "

Analyzes identity documents for relevant information. This information is extracted\n and returned as IdentityDocumentFields, which records both the normalized\n field and value of the extracted text.Unlike other Amazon Textract operations, AnalyzeID \n doesn't return any Geometry data.

" } }, "com.amazonaws.textract#AnalyzeIDDetections": { @@ -329,7 +335,7 @@ "BlockType": { "target": "com.amazonaws.textract#BlockType", "traits": { - "smithy.api#documentation": "

The type of text item that's recognized. In operations for text detection, the following\n types are returned:

\n \n

In text analysis operations, the following types are returned:

\n " + "smithy.api#documentation": "

The type of text item that's recognized. In operations for text detection, the following\n types are returned:

\n \n

In text analysis operations, the following types are returned:

\n " } }, "Confidence": { @@ -409,6 +415,12 @@ "traits": { "smithy.api#documentation": "

The page on which a block was detected. Page is returned by asynchronous\n operations. Page values greater than 1 are only returned for multipage documents that are\n in PDF or TIFF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is\n considered to be a single-page document. The value of Page is always 1.\n Synchronous operations don't return Page because every input document is\n considered to be a single-page document.

" } + }, + "Query": { + "target": "com.amazonaws.textract#Query", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -460,6 +472,14 @@ { "value": "TITLE", "name": "TITLE" + }, + { + "value": "QUERY", + "name": "QUERY" + }, + { + "value": "QUERY_RESULT", + "name": "QUERY_RESULT" } ] } @@ -571,7 +591,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects text in the input document. Amazon Textract can detect lines of text and the\n words that make up a line of text. The input document must be an image in JPEG or PNG\n format. DetectDocumentText returns the detected text in an array of Block objects.

\n

Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

\n \n

\n DetectDocumentText is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentTextDetection.

\n

For more information, see Document Text Detection.

" + "smithy.api#documentation": "

Detects text in the input document. Amazon Textract can detect lines of text and the\n words that make up a line of text. The input document must be an image in JPEG, PNG, PDF, or TIFF\n format. DetectDocumentText returns the detected text in an array of Block objects.

\n

Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

\n \n

\n DetectDocumentText is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentTextDetection.

\n

For more information, see Document Text Detection.

" } }, "com.amazonaws.textract#DetectDocumentTextRequest": { @@ -836,6 +856,10 @@ { "value": "FORMS", "name": "FORMS" + }, + { + "value": "QUERIES", + "name": "QUERIES" } ] } @@ -913,7 +937,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

\n

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier\n (JobId). When the text analysis operation finishes, Amazon Textract publishes a\n completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to\n StartDocumentAnalysis. To get the results of the text-detection operation,\n first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetDocumentAnalysis, and pass the job identifier\n (JobId) from the initial call to StartDocumentAnalysis.

\n

\n GetDocumentAnalysis returns an array of Block objects. The following\n types of information are returned:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n \n \n \n

Use the MaxResults parameter to limit the number of blocks that are\n returned. If there are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting\n the next set of results. To get the next page of results, call\n GetDocumentAnalysis, and populate the NextToken request\n parameter with the token value that's returned from the previous call to\n GetDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" + "smithy.api#documentation": "

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

\n

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier\n (JobId). When the text analysis operation finishes, Amazon Textract publishes a\n completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to\n StartDocumentAnalysis. To get the results of the text-detection operation,\n first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetDocumentAnalysis, and pass the job identifier\n (JobId) from the initial call to StartDocumentAnalysis.

\n

\n GetDocumentAnalysis returns an array of Block objects. The following\n types of information are returned:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n \n \n

Use the MaxResults parameter to limit the number of blocks that are\n returned. If there are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting\n the next set of results. To get the next page of results, call\n GetDocumentAnalysis, and populate the NextToken request\n parameter with the token value that's returned from the previous call to\n GetDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" } }, "com.amazonaws.textract#GetDocumentAnalysisRequest": { @@ -1750,6 +1774,90 @@ "smithy.api#error": "client" } }, + "com.amazonaws.textract#Queries": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#Query" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.textract#QueriesConfig": { + "type": "structure", + "members": { + "Queries": { + "target": "com.amazonaws.textract#Queries", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.textract#Query": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.textract#QueryInput", + "traits": { + "smithy.api#documentation": "

Question that Amazon Textract will apply to the document. An example would be \"What is the customer's SSN?\"

", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.textract#QueryInput", + "traits": { + "smithy.api#documentation": "

Alias attached to the query, for ease of location.

" + } + }, + "Pages": { + "target": "com.amazonaws.textract#QueryPages", + "traits": { + "smithy.api#documentation": "

List of pages associated with the query. The following is a list of rules for using this parameter.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Each query contains the question you want to ask in the Text and the alias you want to associate.

" + } + }, + "com.amazonaws.textract#QueryInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s!\"\\#\\$%'&\\(\\)\\*\\+\\,\\-\\./:;=\\?@\\[\\\\\\]\\^_`\\{\\|\\}~><]+$" + } + }, + "com.amazonaws.textract#QueryPage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 9 + }, + "smithy.api#pattern": "^[0-9\\*\\-]+$" + } + }, + "com.amazonaws.textract#QueryPages": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#QueryPage" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.textract#Relationship": { "type": "structure", "members": { @@ -1799,6 +1907,10 @@ { "value": "TITLE", "name": "TITLE" + }, + { + "value": "ANSWER", + "name": "ANSWER" } ] } @@ -1990,6 +2102,9 @@ "traits": { "smithy.api#documentation": "

The KMS key used to encrypt the inference results. This can be \n in either Key ID or Key Alias format. When a KMS key is provided, the \n KMS key will be used for server-side encryption of the objects in the \n customer bucket. When this parameter is not enabled, the result will \n be encrypted server side,using SSE-S3.

" } + }, + "QueriesConfig": { + "target": "com.amazonaws.textract#QueriesConfig" } } }, @@ -2327,7 +2442,7 @@ } }, "traits": { - "smithy.api#documentation": "

The format of the input document isn't supported. Documents for synchronous operations can be in\n PNG or JPEG format only. Documents for asynchronous operations can be in PDF format.

", + "smithy.api#documentation": "

The format of the input document isn't supported. Documents for operations can be in\n PNG, JPEG, PDF, or TIFF format.

", "smithy.api#error": "client" } }, diff --git a/codegen/sdk/aws-models/transfer.json b/codegen/sdk/aws-models/transfer.json index f132f531e41..227dddd6133 100644 --- a/codegen/sdk/aws-models/transfer.json +++ b/codegen/sdk/aws-models/transfer.json @@ -179,7 +179,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -422,7 +422,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n\n

\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n\n

\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -535,7 +535,7 @@ "Steps": { "target": "com.amazonaws.transfer#WorkflowSteps", "traits": { - "smithy.api#documentation": "

Specifies the details for the steps that are in the specified workflow.

\n

\n The TYPE specifies which of the following actions is being taken for this step.\n

\n \n \n

\n Currently, copying and tagging are supported only on S3.\n

\n \n

\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n

", + "smithy.api#documentation": "

Specifies the details for the steps that are in the specified workflow.

\n

\n The TYPE specifies which of the following actions is being taken for this step.\n

\n \n \n

\n Currently, copying and tagging are supported only on S3.\n

\n \n

\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n

", "smithy.api#required": {} } }, @@ -640,6 +640,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteAccessRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -682,6 +685,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteServerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#AccessDeniedException" @@ -720,6 +726,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteSshPublicKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -792,6 +801,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -834,6 +846,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteWorkflowRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#AccessDeniedException" @@ -1888,7 +1903,7 @@ "StepType": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "

One of the available step types.

\n " + "smithy.api#documentation": "

One of the available step types.

\n " } }, "Outputs": { @@ -1995,7 +2010,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an object that contains entries and targets for\n HomeDirectoryMappings.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Represents an object that contains entries and targets for\n HomeDirectoryMappings.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "com.amazonaws.transfer#HomeDirectoryMappings": { @@ -3738,6 +3753,9 @@ "input": { "target": "com.amazonaws.transfer#StartServerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -3820,6 +3838,9 @@ "input": { "target": "com.amazonaws.transfer#StopServerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -3910,6 +3931,9 @@ "input": { "target": "com.amazonaws.transfer#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -4245,6 +4269,9 @@ "input": { "target": "com.amazonaws.transfer#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -4329,7 +4356,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -4563,7 +4590,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

\n\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

\n\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -4761,7 +4788,7 @@ "Type": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "

\n Currently, the following step types are supported.\n

\n " + "smithy.api#documentation": "

\n Currently, the following step types are supported.\n

\n " } }, "CopyStepDetails": { diff --git a/codegen/sdk/aws-models/wisdom.json b/codegen/sdk/aws-models/wisdom.json index 09b5f68738f..9e1e171fc65 100644 --- a/codegen/sdk/aws-models/wisdom.json +++ b/codegen/sdk/aws-models/wisdom.json @@ -27,7 +27,7 @@ "objectFields": { "target": "com.amazonaws.wisdom#ObjectFieldsList", "traits": { - "smithy.api#documentation": "

The fields from the source that are made available to your agents in Wisdom.

\n \n

Make sure to include additional field(s); these are indexed and used to source\n recommendations.

", + "smithy.api#documentation": "

The fields from the source that are made available to your agents in Wisdom.

\n \n

Make sure to include additional fields. These fields are indexed and used to source\n recommendations.

", "smithy.api#required": {} } } @@ -85,10 +85,7 @@ ], "traits": { "aws.api#arn": { - "template": "assistant/{assistantId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "assistant/{assistantId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} @@ -118,10 +115,7 @@ }, "traits": { "aws.api#arn": { - "template": "association/{assistantId}/{assistantAssociationId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "association/{assistantId}/{assistantAssociationId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} @@ -154,7 +148,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -194,7 +188,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base.

" } } }, @@ -243,7 +237,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -296,7 +290,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -394,7 +388,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -518,10 +512,7 @@ ], "traits": { "aws.api#arn": { - "template": "content/{knowledgeBaseId}/{contentId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "content/{knowledgeBaseId}/{contentId}" }, "aws.iam#disableConditionKeyInference": {} } @@ -553,7 +544,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

", + "smithy.api#documentation": "

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -615,8 +606,7 @@ "target": "com.amazonaws.wisdom#Url", "traits": { "smithy.api#documentation": "

The URL of the content.

", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "urlExpiry": { @@ -647,6 +637,12 @@ }, "value": { "target": "com.amazonaws.wisdom#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } } }, "com.amazonaws.wisdom#ContentReference": { @@ -661,7 +657,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base.

" } }, "contentArn": { @@ -743,7 +739,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

", + "smithy.api#documentation": "

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -826,7 +822,7 @@ "com.amazonaws.wisdom#ContentType": { "type": "string", "traits": { - "smithy.api#pattern": "^(text/(plain|html))|(application/x\\.wisdom-json;source=(salesforce|servicenow))$" + "smithy.api#pattern": "^(text/(plain|html))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" } }, "com.amazonaws.wisdom#CreateAssistant": { @@ -854,9 +850,8 @@ "traits": { "smithy.api#documentation": "

Creates an Amazon Connect Wisdom assistant.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -889,9 +884,8 @@ "traits": { "smithy.api#documentation": "

Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the\n only supported association is with a knowledge base. An assistant can have only a single\n association.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/associations", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1030,9 +1024,8 @@ "traits": { "smithy.api#documentation": "

Creates Wisdom content. Before to calling this API, use StartContentUpload to\n upload an asset.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/contents", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1043,7 +1036,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1131,9 +1124,8 @@ "traits": { "smithy.api#documentation": "

Creates a knowledge base.

\n \n

When using this API, you cannot reuse Amazon AppIntegrations\n DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do,\n you'll get an InvalidRequestException error.

\n\n

For example, you're programmatically managing your external knowledge base, and you want\n to add or remove one of the fields that is being ingested from Salesforce. Do the\n following:

\n
    \n
  1. \n

    Call DeleteKnowledgeBase.

    \n
    2. \n
  2. \n

    Call DeleteDataIntegration.

    \n
    3. \n
  3. \n

    Call CreateDataIntegration to recreate the DataIntegration or a create different\n one.

    \n
    4. \n
  4. \n

    Call CreateKnowledgeBase.

    \n
    5. \n
\n ", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1227,9 +1219,8 @@ "traits": { "smithy.api#documentation": "

Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is\n enabled.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/sessions", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1306,8 +1297,8 @@ "traits": { "smithy.api#documentation": "

Deletes an assistant.

", "smithy.api#http": { - "method": "DELETE", "uri": "/assistants/{assistantId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1335,8 +1326,8 @@ "traits": { "smithy.api#documentation": "

Deletes an assistant association.

", "smithy.api#http": { - "method": "DELETE", "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1406,8 +1397,8 @@ "traits": { "smithy.api#documentation": "

Deletes the content.

", "smithy.api#http": { - "method": "DELETE", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1419,7 +1410,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1455,13 +1446,16 @@ }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the knowledge base.

\n \n

When you use this API to delete an external knowledge base such as Salesforce or\n ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration.\n This is because you can't reuse the DataIntegration after it's been associated with an\n external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API\n Reference.

\n ", "smithy.api#http": { - "method": "DELETE", "uri": "/knowledgeBases/{knowledgeBaseId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1525,10 +1519,9 @@ "type": "structure", "members": { "text": { - "target": "smithy.api#String", + "target": "com.amazonaws.wisdom#SensitiveString", "traits": { - "smithy.api#documentation": "

Text in the document.

", - "smithy.api#sensitive": {} + "smithy.api#documentation": "

Text in the document.

" } }, "highlights": { @@ -1631,9 +1624,8 @@ "traits": { "smithy.api#documentation": "

Retrieves information about an assistant.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1660,9 +1652,8 @@ "traits": { "smithy.api#documentation": "

Retrieves information about an assistant association.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1745,9 +1736,8 @@ "traits": { "smithy.api#documentation": "

Retrieves content, including a pre-signed URL to download the content.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1766,7 +1756,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1806,9 +1796,8 @@ "traits": { "smithy.api#documentation": "

Retrieves summary information about the content.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1827,7 +1816,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1867,9 +1856,8 @@ "traits": { "smithy.api#documentation": "

Retrieves information about the knowledge base.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1880,7 +1868,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1920,9 +1908,8 @@ "traits": { "smithy.api#documentation": "

Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1971,6 +1958,12 @@ "smithy.api#documentation": "

The recommendations.

", "smithy.api#required": {} } + }, + "triggers": { + "target": "com.amazonaws.wisdom#RecommendationTriggerList", + "traits": { + "smithy.api#documentation": "

The triggers corresponding to recommendations.

" + } } } }, @@ -1996,9 +1989,8 @@ "traits": { "smithy.api#documentation": "

Retrieves information for a specified session.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/sessions/{sessionId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2113,10 +2105,7 @@ ], "traits": { "aws.api#arn": { - "template": "knowledge-base/{knowledgeBaseId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "knowledge-base/{knowledgeBaseId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} @@ -2128,7 +2117,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base.

" } }, "knowledgeBaseArn": { @@ -2148,7 +2137,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

", + "smithy.api#documentation": "

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -2270,7 +2259,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

", + "smithy.api#documentation": "

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -2305,7 +2294,7 @@ "sourceConfiguration": { "target": "com.amazonaws.wisdom#SourceConfiguration", "traits": { - "smithy.api#documentation": "

[KEVIN]

" + "smithy.api#documentation": "

Configuration information about the external data source.

" } }, "renderingConfiguration": { @@ -2379,15 +2368,14 @@ "traits": { "smithy.api#documentation": "

Lists information about assistant associations.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/associations", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "assistantAssociationSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "assistantAssociationSummaries" }, "smithy.api#readonly": {} } @@ -2456,15 +2444,14 @@ "traits": { "smithy.api#documentation": "

Lists information about assistants.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "assistantSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "assistantSummaries" }, "smithy.api#readonly": {} } @@ -2528,15 +2515,14 @@ "traits": { "smithy.api#documentation": "

Lists the content.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}/contents", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "contentSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "contentSummaries" }, "smithy.api#readonly": {} } @@ -2561,7 +2547,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2605,15 +2591,14 @@ "traits": { "smithy.api#documentation": "

Lists the knowledge bases.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "knowledgeBaseSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "knowledgeBaseSummaries" }, "smithy.api#readonly": {} } @@ -2671,9 +2656,8 @@ "traits": { "smithy.api#documentation": "

Lists the tags for the specified resource.

", "smithy.api#http": { - "method": "GET", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2762,9 +2746,8 @@ "traits": { "smithy.api#documentation": "

Removes the specified recommendations from the specified assistant's queue of newly\n available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling\n behavior and avoiding duplicate recommendations.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -2890,17 +2873,19 @@ "traits": { "smithy.api#documentation": "

Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.\n

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/query", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "results", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "results" }, - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] } }, "com.amazonaws.wisdom#QueryAssistantRequest": { @@ -2953,6 +2938,20 @@ } } }, + "com.amazonaws.wisdom#QueryRecommendationTriggerData": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.wisdom#QueryText", + "traits": { + "smithy.api#documentation": "

The text associated with the recommendation trigger.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data associated with the QUERY RecommendationTriggerType.

" + } + }, "com.amazonaws.wisdom#QueryResultsList": { "type": "list", "member": { @@ -2993,6 +2992,12 @@ "traits": { "smithy.api#documentation": "

The relevance level of the recommendation.

" } + }, + "type": { + "target": "com.amazonaws.wisdom#RecommendationType", + "traits": { + "smithy.api#documentation": "

The type of recommendation.

" + } } }, "traits": { @@ -3011,6 +3016,110 @@ "target": "com.amazonaws.wisdom#RecommendationData" } }, + "com.amazonaws.wisdom#RecommendationSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ISSUE_DETECTION", + "name": "ISSUE_DETECTION" + }, + { + "value": "RULE_EVALUATION", + "name": "RULE_EVALUATION" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.wisdom#RecommendationTrigger": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the recommendation trigger.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.wisdom#RecommendationTriggerType", + "traits": { + "smithy.api#documentation": "

The type of recommendation trigger.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.wisdom#RecommendationSourceType", + "traits": { + "smithy.api#documentation": "

The source of the recommendation trigger.

\n ", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.wisdom#RecommendationTriggerData", + "traits": { + "smithy.api#documentation": "

A union type containing information related to the trigger.

", + "smithy.api#required": {} + } + }, + "recommendationIds": { + "target": "com.amazonaws.wisdom#RecommendationIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of the recommendations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A recommendation trigger provides context on the event that produced the referenced recommendations.\n Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

" + } + }, + "com.amazonaws.wisdom#RecommendationTriggerData": { + "type": "union", + "members": { + "query": { + "target": "com.amazonaws.wisdom#QueryRecommendationTriggerData", + "traits": { + "smithy.api#documentation": "

Data associated with the QUERY RecommendationTriggerType.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A union type containing information related to the trigger.

" + } + }, + "com.amazonaws.wisdom#RecommendationTriggerList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#RecommendationTrigger" + } + }, + "com.amazonaws.wisdom#RecommendationTriggerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUERY", + "name": "QUERY" + } + ] + } + }, + "com.amazonaws.wisdom#RecommendationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_CONTENT", + "name": "KNOWLEDGE_CONTENT" + } + ] + } + }, "com.amazonaws.wisdom#RelevanceLevel": { "type": "string", "traits": { @@ -3060,8 +3169,8 @@ "traits": { "smithy.api#documentation": "

Removes a URI template from a knowledge base.

", "smithy.api#http": { - "method": "DELETE", "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", + "method": "DELETE", "code": 204 } } @@ -3072,7 +3181,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3166,15 +3275,14 @@ "traits": { "smithy.api#documentation": "

Searches for content in a specified knowledge base. Can be used to get a specific content\n resource by its name.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/search", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "contentSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "contentSummaries" }, "smithy.api#readonly": {} } @@ -3199,7 +3307,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3268,15 +3376,14 @@ "traits": { "smithy.api#documentation": "

Searches for sessions.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/searchSessions", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "sessionSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "sessionSummaries" }, "smithy.api#readonly": {} } @@ -3333,13 +3440,19 @@ } } }, + "com.amazonaws.wisdom#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.wisdom#ServerSideEncryptionConfiguration": { "type": "structure", "members": { "kmsKeyId": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The KMS key. For information about valid ID values, see Key identifiers (KeyId).

" } } }, @@ -3378,10 +3491,7 @@ }, "traits": { "aws.api#arn": { - "template": "session/{assistantId}/{sessionId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "session/{assistantId}/{sessionId}" }, "aws.iam#disableConditionKeyInference": {} } @@ -3460,7 +3570,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } } @@ -3505,9 +3615,8 @@ "traits": { "smithy.api#documentation": "

Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a\n knowledge base of type CUSTOM.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/upload", - "code": 200 + "method": "POST" } } }, @@ -3517,7 +3626,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3545,8 +3654,7 @@ "target": "com.amazonaws.wisdom#Url", "traits": { "smithy.api#documentation": "

The URL of the upload.

", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "urlExpiry": { @@ -3607,9 +3715,8 @@ "traits": { "smithy.api#documentation": "

Adds the specified tags to the specified resource.

", "smithy.api#http": { - "method": "POST", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -3691,9 +3798,8 @@ "traits": { "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", "smithy.api#http": { - "method": "DELETE", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -3748,9 +3854,8 @@ "traits": { "smithy.api#documentation": "

Updates information about the content.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", - "code": 200 + "method": "POST" } } }, @@ -3760,7 +3865,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3844,9 +3949,8 @@ "traits": { "smithy.api#documentation": "

Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", - "code": 200 + "method": "POST" } } }, @@ -3856,7 +3960,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3896,7 +4000,8 @@ "smithy.api#length": { "min": 1, "max": 4096 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#Uuid": { @@ -3919,7 +4024,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

", + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by a service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3935,6 +4040,20 @@ }, "com.amazonaws.wisdom#WisdomService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Wisdom", + "arnNamespace": "wisdom", + "cloudFormationName": "Wisdom" + }, + "aws.auth#sigv4": { + "name": "wisdom" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively\n speaking with customers. Agents can search across connected repositories from within their agent desktop\n to find answers quickly. Use the Amazon Connect Wisdom APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

", + "smithy.api#title": "Amazon Connect Wisdom Service" + }, "version": "2020-10-19", "operations": [ { @@ -3954,23 +4073,7 @@ { "target": "com.amazonaws.wisdom#KnowledgeBase" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Wisdom", - "arnNamespace": "wisdom", - "cloudFormationName": "Wisdom", - "cloudTrailEventSource": "wisdom.amazonaws.com", - "endpointPrefix": "wisdom" - }, - "aws.auth#sigv4": { - "name": "wisdom" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": {}, - "smithy.api#documentation": "

All Amazon Connect Wisdom functionality is accessible using the API. For example, you can create an\n assistant and a knowledge base.

\n\n

Some more advanced features are only accessible using the Wisdom API. For example, you\n can manually manage content by uploading custom files and control their lifecycle.

", - "smithy.api#title": "Amazon Connect Wisdom Service" - } + ] } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/worklink.json b/codegen/sdk/aws-models/worklink.json index 1ee3df97731..7b8ca007801 100644 --- a/codegen/sdk/aws-models/worklink.json +++ b/codegen/sdk/aws-models/worklink.json @@ -32,7 +32,7 @@ "com.amazonaws.worklink#AcmCertificateArn": { "type": "string", "traits": { - "smithy.api#pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*" + "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*$" } }, "com.amazonaws.worklink#AssociateDomain": { @@ -64,6 +64,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Specifies a domain to be associated to Amazon WorkLink.

", "smithy.api#http": { "method": "POST", @@ -137,6 +140,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

", "smithy.api#http": { "method": "POST", @@ -210,6 +216,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Imports the root certificate of a certificate authority (CA) used to obtain TLS\n certificates used by associated websites within the company network.

", "smithy.api#http": { "method": "POST", @@ -284,7 +293,7 @@ "min": 1, "max": 8192 }, - "smithy.api#pattern": "-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" + "smithy.api#pattern": "^-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?$" } }, "com.amazonaws.worklink#CertificateChain": { @@ -294,7 +303,7 @@ "min": 1, "max": 32768 }, - "smithy.api#pattern": "(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" + "smithy.api#pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?$" } }, "com.amazonaws.worklink#CompanyCode": { @@ -335,6 +344,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Creates a fleet. A fleet consists of resources and the configuration that delivers\n associated websites to authorized users who download and set up the Amazon WorkLink app.

", "smithy.api#http": { "method": "POST", @@ -413,6 +425,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Deletes a fleet. Prevents users from accessing previously associated websites.

", "smithy.api#http": { "method": "POST", @@ -463,6 +478,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the configuration for delivering audit streams to the customer account.

", "smithy.api#http": { "method": "POST", @@ -520,6 +538,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the networking configuration to access the internal websites associated with\n the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -589,6 +610,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides information about a user's device.

", "smithy.api#http": { "method": "POST", @@ -623,6 +647,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the device policy configuration for the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -758,6 +785,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides information about the domain.

", "smithy.api#http": { "method": "POST", @@ -846,6 +876,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides basic information for the specified fleet, excluding identity provider,\n networking, and device configuration details.

", "smithy.api#http": { "method": "POST", @@ -945,6 +978,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the identity provider configuration of the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1014,6 +1050,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides information about the certificate authority.

", "smithy.api#http": { "method": "POST", @@ -1176,6 +1215,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

", "smithy.api#http": { "method": "POST", @@ -1236,6 +1278,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Disassociates a website authorization provider from a specified fleet. After the\n disassociation, users can't load any associated websites that require this authorization\n provider.

", "smithy.api#http": { "method": "POST", @@ -1293,6 +1338,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Removes a certificate authority (CA).

", "smithy.api#http": { "method": "POST", @@ -1610,6 +1658,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of devices registered with the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1690,6 +1741,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of domains associated to a specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1767,6 +1821,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of fleets for the current account and Region.

", "smithy.api#http": { "method": "POST", @@ -1828,6 +1885,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of tags for the specified resource.

", "smithy.api#http": { "method": "GET", @@ -1886,6 +1946,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of website authorization providers associated with a specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1963,6 +2026,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of certificate authorities added for the current account and\n Region.

", "smithy.api#http": { "method": "POST", @@ -2033,7 +2099,7 @@ "min": 1, "max": 4096 }, - "smithy.api#pattern": "[\\w\\-]+" + "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.worklink#ResourceAlreadyExistsException": { @@ -2088,6 +2154,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Moves a domain to ACTIVE status if it was in the INACTIVE status.

", "smithy.api#http": { "method": "POST", @@ -2145,6 +2214,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Moves a domain to INACTIVE status if it was in the ACTIVE status.

", "smithy.api#http": { "method": "POST", @@ -2229,6 +2301,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Signs the user out from all of their devices. The user can sign in again if they have\n valid credentials.

", "smithy.api#http": { "method": "POST", @@ -2323,6 +2398,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

", "smithy.api#http": { "method": "POST", @@ -2404,6 +2482,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Removes one or more tags from the specified resource.

", "smithy.api#http": { "method": "DELETE", @@ -2463,6 +2544,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the audit stream configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2519,6 +2603,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the company network configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2590,6 +2677,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the device policy configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2646,6 +2736,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates domain metadata, such as DisplayName.

", "smithy.api#http": { "method": "POST", @@ -2709,6 +2802,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates fleet metadata, such as DisplayName.

", "smithy.api#http": { "method": "POST", @@ -2771,6 +2867,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the identity provider configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2896,6 +2995,21 @@ }, "com.amazonaws.worklink#WorkLink": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "WorkLink", + "arnNamespace": "worklink", + "cloudFormationName": "WorkLink", + "cloudTrailEventSource": "worklink.amazonaws.com", + "endpointPrefix": "worklink" + }, + "aws.auth#sigv4": { + "name": "worklink" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon WorkLink is a cloud-based service that provides secure access\n to internal websites and web apps from iOS and Android phones. In a single step, your users, such as\n employees, can access internal websites as efficiently as they access any other public website.\n They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink\n authenticates the user's access and securely renders authorized internal web content in a secure\n rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on\n mobile devices.

", + "smithy.api#title": "Amazon WorkLink" + }, "version": "2018-09-25", "operations": [ { @@ -2997,22 +3111,7 @@ { "target": "com.amazonaws.worklink#UpdateIdentityProviderConfiguration" } - ], - "traits": { - "aws.api#service": { - "sdkId": "WorkLink", - "arnNamespace": "worklink", - "cloudFormationName": "WorkLink", - "cloudTrailEventSource": "worklink.amazonaws.com", - "endpointPrefix": "worklink" - }, - "aws.auth#sigv4": { - "name": "worklink" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon WorkLink is a cloud-based service that provides secure access\n to internal websites and web apps from iOS and Android phones. In a single step, your users, such as\n employees, can access internal websites as efficiently as they access any other public website.\n They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink\n authenticates the user's access and securely renders authorized internal web content in a secure\n rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on\n mobile devices.

", - "smithy.api#title": "Amazon WorkLink" - } + ] } } }