The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User Guide.
" + "documentation":"The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User Guide.
Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.
Batch on Fargate doesn't currently support Local Zones.
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.
When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
" + "documentation":"The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.
When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.
Batch on Fargate doesn't currently support Local Zones.
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage.
When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty.
When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
A list of job attempts that are associated with this job.
" + }, + "isCancelled":{ + "shape":"Boolean", + "documentation":"Indicates whether the job is canceled.
" + }, + "isTerminated":{ + "shape":"Boolean", + "documentation":"Indicates whether the job is terminated.
" } }, "documentation":"An object that represents an Batch job.
" @@ -2429,7 +2437,7 @@ "members":{ "attemptDurationSeconds":{ "shape":"Integer", - "documentation":"The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds.
The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds.
For array jobs, the timeout applies to the child jobs, not to the parent array job.
For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.
" } }, "documentation":"An object that represents a job timeout configuration.
" diff --git a/services/billingconductor/pom.xml b/services/billingconductor/pom.xml index 905c27527991..b5daa7634ebb 100644 --- a/services/billingconductor/pom.xml +++ b/services/billingconductor/pom.xml @@ -21,7 +21,7 @@Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
" }, "CancelImportTask":{ "name":"CancelImportTask", @@ -506,7 +506,7 @@ }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, - "documentation":"Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
" }, "CopySnapshot":{ "name":"CopySnapshot", @@ -935,7 +935,7 @@ }, "input":{"shape":"CreateRestoreImageTaskRequest"}, "output":{"shape":"CreateRestoreImageTaskResult"}, - "documentation":"Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
" }, "CreateRoute":{ "name":"CreateRoute", @@ -1005,7 +1005,7 @@ }, "input":{"shape":"CreateStoreImageTaskRequest"}, "output":{"shape":"CreateStoreImageTaskResult"}, - "documentation":"Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
" }, "CreateSubnet":{ "name":"CreateSubnet", @@ -2052,7 +2052,7 @@ "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, - "documentation":"Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
" + "documentation":"Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon EC2 User Guide.
When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
" }, "DeregisterInstanceEventNotificationAttributes":{ "name":"DeregisterInstanceEventNotificationAttributes", @@ -3122,7 +3122,7 @@ }, "input":{"shape":"DescribeStoreImageTasksRequest"}, "output":{"shape":"DescribeStoreImageTasksResult"}, - "documentation":"Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
" }, "DescribeSubnets":{ "name":"DescribeSubnets", @@ -3619,7 +3619,7 @@ }, "input":{"shape":"DisableImageDeprecationRequest"}, "output":{"shape":"DisableImageDeprecationResult"}, - "documentation":"Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
" }, "DisableIpamOrganizationAdminAccount":{ "name":"DisableIpamOrganizationAdminAccount", @@ -3856,7 +3856,7 @@ }, "input":{"shape":"EnableImageDeprecationRequest"}, "output":{"shape":"EnableImageDeprecationResult"}, - "documentation":"Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
" }, "EnableIpamOrganizationAdminAccount":{ "name":"EnableIpamOrganizationAdminAccount", @@ -4444,7 +4444,7 @@ }, "input":{"shape":"ListImagesInRecycleBinRequest"}, "output":{"shape":"ListImagesInRecycleBinResult"}, - "documentation":"Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
" }, "ListSnapshotsInRecycleBin":{ "name":"ListSnapshotsInRecycleBin", @@ -5184,7 +5184,7 @@ }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, - "documentation":"Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Create your own AMI in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understand AMI billing information in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Create your own AMI in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understand AMI billing information in the Amazon EC2 User Guide.
" }, "RegisterInstanceEventNotificationAttributes":{ "name":"RegisterInstanceEventNotificationAttributes", @@ -5466,7 +5466,7 @@ }, "input":{"shape":"RestoreImageFromRecycleBinRequest"}, "output":{"shape":"RestoreImageFromRecycleBinResult"}, - "documentation":"Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
" }, "RestoreManagedPrefixListVersion":{ "name":"RestoreManagedPrefixListVersion", @@ -10904,7 +10904,7 @@ }, "Encrypted":{ "shape":"Boolean", - "documentation":"Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EC2 User Guide.
" }, "DryRun":{ "shape":"Boolean", @@ -19360,6 +19360,14 @@ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, @@ -19370,6 +19378,11 @@ "shape":"ImageList", "documentation":"Information about the images.
", "locationName":"imagesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
" }, "InstanceId":{ - "shape":"InstanceId", + "shape":"InstanceIdForResolver", "documentation":"The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
" }, "VolumeId":{ - "shape":"VolumeId", + "shape":"VolumeIdWithResolver", "documentation":"The ID of the volume.
" }, "DryRun":{ @@ -30391,7 +30404,7 @@ }, "PlatformDetails":{ "shape":"String", - "documentation":"The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
", "locationName":"platformDetails" }, "UsageOperation":{ @@ -30476,12 +30489,12 @@ }, "BootMode":{ "shape":"BootModeValues", - "documentation":"The boot mode of the image. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
", "locationName":"bootMode" }, "TpmSupport":{ "shape":"TpmSupportValues", - "documentation":"If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon Elastic Compute Cloud User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
", "locationName":"uefiData" }, "LastLaunchedTime":{ @@ -30562,7 +30575,7 @@ }, "ImdsSupport":{ "shape":"AttributeValue", - "documentation":"If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon Elastic Compute Cloud User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
", "locationName":"BlockDeviceMapping" }, "Description":{ @@ -43978,7 +43992,7 @@ }, "BillingProducts":{ "shape":"BillingProductList", - "documentation":"The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.
", + "documentation":"The billing product codes. Your account must be authorized to specify billing product codes.
If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.
", "locationName":"BillingProduct" }, "RamdiskId":{ @@ -44003,19 +44017,19 @@ }, "BootMode":{ "shape":"BootModeValues", - "documentation":"The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The boot mode of the AMI. For more information, see Boot modes in the Amazon EC2 User Guide.
" }, "TpmSupport":{ "shape":"TpmSupportValues", - "documentation":"Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
" }, "ImdsSupport":{ "shape":"ImdsSupportValues", - "documentation":"Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon Elastic Compute Cloud User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Contains the parameters for RegisterImage.
" @@ -54540,6 +54554,7 @@ "locationName":"VolumeId" } }, + "VolumeIdWithResolver":{"type":"string"}, "VolumeList":{ "type":"list", "member":{ diff --git a/services/ec2instanceconnect/pom.xml b/services/ec2instanceconnect/pom.xml index 9bfdfbd147c6..5e04094b6de3 100644 --- a/services/ec2instanceconnect/pom.xml +++ b/services/ec2instanceconnect/pom.xml @@ -21,7 +21,7 @@Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.
" }, @@ -151,7 +152,8 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ValidationException"} ], "documentation":"Deletes a label.
" }, @@ -167,7 +169,8 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ValidationException"} ], "documentation":"Deletes a group of labels.
" }, @@ -183,7 +186,8 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} ], "documentation":"Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.
" }, @@ -2309,6 +2313,10 @@ "ModelName":{ "shape":"ModelName", "documentation":"The name of the ML model used by the inference scheduler to be listed.
" + }, + "Status":{ + "shape":"InferenceSchedulerStatus", + "documentation":"Specifies the current status of the inference schedulers to list.
" } } }, diff --git a/services/lookoutmetrics/pom.xml b/services/lookoutmetrics/pom.xml index 6e3b7ebf5b34..13098dfa178e 100644 --- a/services/lookoutmetrics/pom.xml +++ b/services/lookoutmetrics/pom.xml @@ -21,7 +21,7 @@Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.
" + "documentation":"Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in the READY state.
Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.
", + "documentation":"Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the READY state.
Create a new Studio.
When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
You may optionally specify a KMS key in the StudioEncryptionConfiguration.
In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.
When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
" + "documentation":"Create a new studio.
When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
You may optionally specify a KMS key in the StudioEncryptionConfiguration.
In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.
When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
" }, "CreateStudioComponent":{ "name":"CreateStudioComponent", @@ -234,7 +234,7 @@ {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.
A streaming session will count against your streaming session quota until it is marked DELETED.
", + "documentation":"Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.
A streaming session will count against your streaming session quota until it is marked DELETED.
Get Eula.
" + "documentation":"Get EULA.
" }, "GetLaunchProfile":{ "name":"GetLaunchProfile", @@ -440,6 +440,25 @@ ], "documentation":"Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
" }, + "GetStreamingSessionBackup":{ + "name":"GetStreamingSessionBackup", + "http":{ + "method":"GET", + "requestUri":"/2020-08-01/studios/{studioId}/streaming-session-backups/{backupId}", + "responseCode":200 + }, + "input":{"shape":"GetStreamingSessionBackupRequest"}, + "output":{"shape":"GetStreamingSessionBackupResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Gets StreamingSessionBackup resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
" + }, "GetStreamingSessionStream":{ "name":"GetStreamingSessionStream", "http":{ @@ -458,7 +477,7 @@ {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.
After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.
" + "documentation":"Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.
After the StreamingSessionStream changes to the READY state, the url property will contain a stream to be used with the DCV streaming client.
Get a Studio resource.
" + "documentation":"Get a studio resource.
" }, "GetStudioComponent":{ "name":"GetStudioComponent", @@ -538,7 +557,7 @@ {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"List Eula Acceptances.
" + "documentation":"List EULA acceptances.
" }, "ListEulas":{ "name":"ListEulas", @@ -558,7 +577,7 @@ {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"List Eulas.
" + "documentation":"List EULAs.
" }, "ListLaunchProfileMembers":{ "name":"ListLaunchProfileMembers", @@ -620,6 +639,25 @@ ], "documentation":"List the streaming image resources available to this studio.
This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
" }, + "ListStreamingSessionBackups":{ + "name":"ListStreamingSessionBackups", + "http":{ + "method":"GET", + "requestUri":"/2020-08-01/studios/{studioId}/streaming-session-backups", + "responseCode":200 + }, + "input":{"shape":"ListStreamingSessionBackupsRequest"}, + "output":{"shape":"ListStreamingSessionBackupsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Lists the backups of a streaming session in a studio.
" + }, "ListStreamingSessions":{ "name":"ListStreamingSessions", "http":{ @@ -658,7 +696,7 @@ {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Lists the StudioComponents in a studio.
" + "documentation":"Lists the StudioComponents in a studio.
List studios in your Amazon Web Services account in the requested Amazon Web Services Region.
" + "documentation":"List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -778,7 +816,7 @@ {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.
", + "documentation":"Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.
Repairs the IAM Identity Center configuration for a given studio.
If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the READY state.
After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
", + "documentation":"Repairs the IAM Identity Center configuration for a given studio.
If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the READY state.
After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
", "idempotent":true }, "StopStreamingSession":{ @@ -820,7 +858,7 @@ {"shape":"InternalServerErrorException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.
", + "documentation":"Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1071,7 +1109,7 @@ "documentation":"The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
" } }, - "documentation":"The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
" + "documentation":"The configuration for a Directory Service for Microsoft Active Directory studio resource.
" }, "ActiveDirectoryDnsIpAddress":{"type":"string"}, "ActiveDirectoryDnsIpAddressList":{ @@ -1086,6 +1124,13 @@ "max":2000, "min":1 }, + "AutomaticTerminationMode":{ + "type":"string", + "enum":[ + "DEACTIVATED", + "ACTIVATED" + ] + }, "ClientToken":{ "type":"string", "max":64, @@ -1141,7 +1186,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1178,7 +1223,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" } } }, @@ -1201,7 +1246,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1226,7 +1271,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" } } }, @@ -1241,11 +1286,14 @@ }, "CreateStreamingSessionRequest":{ "type":"structure", - "required":["studioId"], + "required":[ + "launchProfileId", + "studioId" + ], "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1256,7 +1304,7 @@ }, "launchProfileId":{ "shape":"String", - "documentation":"The launch profile ID.
" + "documentation":"The ID of the launch profile used to control access from the streaming session.
" }, "ownedBy":{ "shape":"String", @@ -1274,7 +1322,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" } } }, @@ -1296,7 +1344,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1338,7 +1386,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1365,7 +1413,7 @@ }, "runtimeRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "documentation":"An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
" }, "scriptParameters":{ "shape":"StudioComponentScriptParameterKeyValueList", @@ -1373,7 +1421,7 @@ }, "secureInitializationRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
" }, "studioId":{ "shape":"String", @@ -1387,7 +1435,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" }, "type":{ "shape":"StudioComponentType", @@ -1415,11 +1463,11 @@ "members":{ "adminRoleArn":{ "shape":"RoleArn", - "documentation":"The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
" + "documentation":"The IAM role that studio admins will assume when logging in to the Nimble Studio portal.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1438,11 +1486,11 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" }, "userRoleArn":{ "shape":"RoleArn", - "documentation":"The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
" + "documentation":"The IAM role that studio users will assume when logging in to the Nimble Studio portal.
" } } }, @@ -1465,14 +1513,14 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -1504,14 +1552,14 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -1541,7 +1589,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1578,7 +1626,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1615,7 +1663,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1652,7 +1700,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1682,7 +1730,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -1726,7 +1774,7 @@ }, "createdAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was created.
" + "documentation":"The ISO timestamp in seconds for when the resource was created.
" }, "eulaId":{ "shape":"EulaId", @@ -1738,7 +1786,7 @@ }, "updatedAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was updated.
" + "documentation":"The ISO timestamp in seconds for when the resource was updated.
" } }, "documentation":"Represents a EULA resource.
" @@ -1748,7 +1796,7 @@ "members":{ "acceptedAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the EULA was accepted.
" + "documentation":"The ISO timestamp in seconds for when the EULA was accepted.
" }, "acceptedBy":{ "shape":"String", @@ -1804,7 +1852,7 @@ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"}, - "documentation":"ExceptionContext is a set of key-value pairs that provide you with more information about the error that occurred. For example, when the service returns a 404 ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the value of resource that was not found.
ExceptionContext enables scripts and other programmatic clients to provide for better error handling.
" + "documentation":"ExceptionContext is a set of key-value pairs that provide you with more information about the error that occurred. For example, when the service returns a 404 ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the value of resource that was not found.
ExceptionContext allows scripts and other programmatic clients to provide better error handling.
The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -1877,7 +1925,7 @@ "members":{ "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -1895,7 +1943,7 @@ }, "platform":{ "shape":"String", - "documentation":"The platform where this Launch Profile will be used, either WINDOWS or LINUX.
", + "documentation":"The platform where this Launch Profile will be used, either Windows or Linux.
", "location":"querystring", "locationName":"platform" }, @@ -1926,7 +1974,7 @@ "members":{ "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -1962,7 +2010,7 @@ "members":{ "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -2013,6 +2061,36 @@ } } }, + "GetStreamingSessionBackupRequest":{ + "type":"structure", + "required":[ + "backupId", + "studioId" + ], + "members":{ + "backupId":{ + "shape":"String", + "documentation":"The ID of the backup.
", + "location":"uri", + "locationName":"backupId" + }, + "studioId":{ + "shape":"String", + "documentation":"The studio ID.
", + "location":"uri", + "locationName":"studioId" + } + } + }, + "GetStreamingSessionBackupResponse":{ + "type":"structure", + "members":{ + "streamingSessionBackup":{ + "shape":"StreamingSessionBackup", + "documentation":"Information about the streaming session backup.
" + } + } + }, "GetStreamingSessionRequest":{ "type":"structure", "required":[ @@ -2189,11 +2267,11 @@ "members":{ "arn":{ "shape":"String", - "documentation":"The ARN of the resource.
" + "documentation":"The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
" }, "createdAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was created.
" + "documentation":"The ISO timestamp in seconds for when the resource was created.
" }, "createdBy":{ "shape":"String", @@ -2209,7 +2287,7 @@ }, "launchProfileId":{ "shape":"LaunchProfileId", - "documentation":"The launch profile ID.
" + "documentation":"The ID of the launch profile used to control access from the streaming session.
" }, "launchProfileProtocolVersions":{ "shape":"LaunchProfileProtocolVersionList", @@ -2241,11 +2319,11 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" }, "updatedAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was updated.
" + "documentation":"The ISO timestamp in seconds for when the resource was updated.
" }, "updatedBy":{ "shape":"String", @@ -2256,7 +2334,7 @@ "documentation":"The list of the latest validation results.
" } }, - "documentation":"A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).
<p>Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.</p> A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).
Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.
" }, "LaunchProfileDescription":{ "type":"string", @@ -2276,7 +2354,7 @@ "members":{ "activeDirectory":{ "shape":"LaunchProfileInitializationActiveDirectory", - "documentation":"A LaunchProfileInitializationActiveDirectory resource.
" + "documentation":"A LaunchProfileInitializationActiveDirectory resource.
The launch profile ID.
" + "documentation":"The ID of the launch profile used to control access from the streaming session.
" }, "launchProfileProtocolVersion":{ "shape":"LaunchProfileProtocolVersion", @@ -2300,7 +2378,7 @@ }, "platform":{ "shape":"LaunchProfilePlatform", - "documentation":"The platform of the launch platform, either WINDOWS or LINUX.
" + "documentation":"The platform of the launch platform, either Windows or Linux.
" }, "systemInitializationScripts":{ "shape":"LaunchProfileInitializationScriptList", @@ -2311,7 +2389,7 @@ "documentation":"The user initializtion scripts.
" } }, - "documentation":"A Launch Profile Initialization contains information required for a workstation or server to connect to a launch profile.
This includes scripts, endpoints, security groups, subnets, and other configuration.
" + "documentation":"A launch profile initialization contains information required for a workstation or server to connect to a launch profile.
This includes scripts, endpoints, security groups, subnets, and other configuration.
" }, "LaunchProfileInitializationActiveDirectory":{ "type":"structure", @@ -2345,14 +2423,14 @@ "documentation":"The name for the studio component.
" } }, - "documentation":"The Launch Profile Initialization Active Directory contains information required for the launch profile to connect to the Active Directory.
" + "documentation":"The launch profile initialization Active Directory contains information required for the launch profile to connect to the Active Directory.
" }, "LaunchProfileInitializationScript":{ "type":"structure", "members":{ "runtimeRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "documentation":"An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
" }, "script":{ "shape":"StudioComponentInitializationScriptContent", @@ -2360,7 +2438,7 @@ }, "secureInitializationRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
" }, "studioComponentId":{ "shape":"StudioComponentId", @@ -2371,7 +2449,7 @@ "documentation":"The name for the studio component.
" } }, - "documentation":"The Launch Profile Initialization Script is used when start streaming session runs.
" + "documentation":"The launch profile initialization script is used when start streaming session runs.
" }, "LaunchProfileInitializationScriptList":{ "type":"list", @@ -2401,7 +2479,7 @@ "documentation":"The Active Directory Security Identifier for this user, if available.
" } }, - "documentation":"Launch profile membership enables your studio admins to delegate launch profile access to other studio users in the Nimble Studio portal without needing to write or maintain complex IAM policies. A launch profile member is a user association from your studio identity source who is granted permissions to a launch profile.
A launch profile member (type USER) provides the following permissions to that launch profile:
GetLaunchProfile
GetLaunchProfileInitialization
GetLaunchProfileMembers
GetLaunchProfileMember
CreateStreamingSession
GetLaunchProfileDetails
Studio admins can use launch profile membership to delegate launch profile access to studio users in the Nimble Studio portal without writing or maintaining complex IAM policies. A launch profile member is a user association from your studio identity source who is granted permissions to a launch profile.
A launch profile member (type USER) provides the following permissions to that launch profile:
GetLaunchProfile
GetLaunchProfileInitialization
GetLaunchProfileMembers
GetLaunchProfileMember
CreateStreamingSession
GetLaunchProfileDetails
The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" }, @@ -2591,7 +2669,7 @@ }, "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" } @@ -2619,7 +2697,7 @@ "members":{ "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -2631,7 +2709,7 @@ }, "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" }, @@ -2668,7 +2746,7 @@ }, "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" }, @@ -2711,7 +2789,7 @@ "members":{ "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" }, @@ -2742,6 +2820,43 @@ } } }, + "ListStreamingSessionBackupsRequest":{ + "type":"structure", + "required":["studioId"], + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"The token for the next set of results, or null if there are no more results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "ownedBy":{ + "shape":"String", + "documentation":"The user ID of the user that owns the streaming session.
", + "location":"querystring", + "locationName":"ownedBy" + }, + "studioId":{ + "shape":"String", + "documentation":"The studio ID.
", + "location":"uri", + "locationName":"studioId" + } + } + }, + "ListStreamingSessionBackupsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"The token for the next set of results, or null if there are no more results.
" + }, + "streamingSessionBackups":{ + "shape":"StreamingSessionBackupList", + "documentation":"Information about the streaming session backups.
" + } + } + }, "ListStreamingSessionsRequest":{ "type":"structure", "required":["studioId"], @@ -2754,7 +2869,7 @@ }, "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" }, @@ -2803,7 +2918,7 @@ }, "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" }, @@ -2852,7 +2967,7 @@ }, "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" }, @@ -2882,7 +2997,7 @@ "members":{ "nextToken":{ "shape":"String", - "documentation":"The token to request the next page of results.
", + "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"nextToken" } @@ -2919,12 +3034,13 @@ "members":{ "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" } } }, "MaxResults":{ "type":"integer", + "box":true, "max":100, "min":1 }, @@ -2987,7 +3103,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -2998,7 +3114,7 @@ }, "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -3029,7 +3145,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -3108,7 +3224,7 @@ "documentation":"A script parameter value.
" } }, - "documentation":"A parameter for a studio component script, in the form of a key:value pair.
" + "documentation":"A parameter for a studio component script, in the form of a key-value pair.
" }, "ScriptParameterValue":{ "type":"string", @@ -3137,13 +3253,27 @@ "documentation":"A human-readable description of the error.
" } }, - "documentation":"Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.
Please use AWS Service Quotas to request an increase.
", + "documentation":"Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.
Please use Amazon Web Services Service Quotas to request an increase.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, + "SessionBackupMode":{ + "type":"string", + "enum":[ + "AUTOMATIC", + "DEACTIVATED" + ] + }, + "SessionPersistenceMode":{ + "type":"string", + "enum":[ + "DEACTIVATED", + "ACTIVATED" + ] + }, "SharedFileSystemConfiguration":{ "type":"structure", "members":{ @@ -3177,16 +3307,20 @@ "studioId" ], "members":{ + "backupId":{ + "shape":"String", + "documentation":"The ID of the backup.
" + }, "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "sessionId":{ "shape":"String", - "documentation":"The streaming session ID for the StartStreamingSessionRequest.
", + "documentation":"The streaming session ID for the StartStreamingSessionRequest.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -3242,14 +3376,14 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "sessionId":{ "shape":"String", - "documentation":"The streaming session ID for the StopStreamingSessionRequest.
", + "documentation":"The streaming session ID for the StopStreamingSessionRequest.
The studioId for the StopStreamingSessionRequest.
", "location":"uri", "locationName":"studioId" + }, + "volumeRetentionMode":{ + "shape":"VolumeRetentionMode", + "documentation":"Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.
" } } }, @@ -3275,9 +3413,13 @@ "streamingImageIds" ], "members":{ + "automaticTerminationMode":{ + "shape":"AutomaticTerminationMode", + "documentation":"Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.
When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.
Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
" + "documentation":"Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
" }, "ec2InstanceTypes":{ "shape":"StreamingInstanceTypeList", @@ -3289,15 +3431,27 @@ }, "maxStoppedSessionLengthInMinutes":{ "shape":"StreamConfigurationMaxStoppedSessionLengthInMinutes", - "documentation":"Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
Information about the streaming session backup.
" + }, + "sessionPersistenceMode":{ + "shape":"SessionPersistenceMode", + "documentation":"Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
(Optional) The upload storage for a streaming session.
" + "documentation":"The upload storage for a streaming session.
" }, "streamingImageIds":{ "shape":"StreamingImageIdList", "documentation":"The streaming images that users can select from when launching a streaming session with this launch profile.
" + }, + "volumeConfiguration":{ + "shape":"VolumeConfiguration", + "documentation":"Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
A configuration for a streaming session.
" @@ -3310,9 +3464,13 @@ "streamingImageIds" ], "members":{ + "automaticTerminationMode":{ + "shape":"AutomaticTerminationMode", + "documentation":"Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.
When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.
Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
" + "documentation":"Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
" }, "ec2InstanceTypes":{ "shape":"StreamingInstanceTypeList", @@ -3324,21 +3482,39 @@ }, "maxStoppedSessionLengthInMinutes":{ "shape":"StreamConfigurationMaxStoppedSessionLengthInMinutes", - "documentation":"Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
Configures how streaming sessions are backed up when launched from this launch profile.
" + }, + "sessionPersistenceMode":{ + "shape":"SessionPersistenceMode", + "documentation":"Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
(Optional) The upload storage for a streaming workstation that is created using this launch profile.
" + "documentation":"The upload storage for a streaming workstation that is created using this launch profile.
" }, "streamingImageIds":{ "shape":"StreamingImageIdList", "documentation":"The streaming images that users can select from when launching a streaming session with this launch profile.
" + }, + "volumeConfiguration":{ + "shape":"VolumeConfiguration", + "documentation":"Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
Configuration for streaming workstations created using this launch profile.
" }, + "StreamConfigurationMaxBackupsToRetain":{ + "type":"integer", + "max":10, + "min":0 + }, "StreamConfigurationMaxSessionLengthInMinutes":{ "type":"integer", + "box":true, "max":43200, "min":1 }, @@ -3347,6 +3523,20 @@ "max":5760, "min":0 }, + "StreamConfigurationSessionBackup":{ + "type":"structure", + "members":{ + "maxBackupsToRetain":{ + "shape":"StreamConfigurationMaxBackupsToRetain", + "documentation":"The maximum number of backups that each streaming session created from this launch profile can have.
" + }, + "mode":{ + "shape":"SessionBackupMode", + "documentation":"Specifies how artists sessions are backed up.
Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
Configures how streaming sessions are backed up when launched from this launch profile.
" + }, "StreamConfigurationSessionStorage":{ "type":"structure", "required":["mode"], @@ -3374,7 +3564,7 @@ "members":{ "arn":{ "shape":"String", - "documentation":"The ARN of the resource.
" + "documentation":"The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
" }, "description":{ "shape":"StreamingImageDescription", @@ -3398,11 +3588,11 @@ }, "owner":{ "shape":"StreamingImageOwner", - "documentation":"The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
" + "documentation":"The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
The platform of the streaming image, either WINDOWS or LINUX.
" + "documentation":"The platform of the streaming image, either Windows or Linux.
" }, "state":{ "shape":"StreamingImageState", @@ -3422,10 +3612,10 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" } }, - "documentation":"Represents a streaming image resource.
Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
Amazon provides a number of streaming images that include popular 3rd-party software.
You can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.
" + "documentation":"Represents a streaming image resource.
Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
Amazon provides a number of streaming images that include popular 3rd-party software.
You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.
" }, "StreamingImageDescription":{ "type":"string", @@ -3484,11 +3674,11 @@ }, "StreamingImageOwner":{ "type":"string", - "documentation":"StreamingImageOwner is the owner of a particular streaming image.
This string is either the studioId that contains the streaming image, or the word 'AMAZON' for images provided by Nimble Studio.
" + "documentation":"StreamingImageOwner is the owner of a particular streaming image.
This string is either the studioId that contains the streaming image, or the word AMAZON for images provided by Nimble Studio.
The platform of this Streaming Image, either WINDOWS or LINUX.
", + "documentation":"The platform of this streaming image, either Windows or Linux.
", "pattern":"^[a-zA-Z]*$" }, "StreamingImageState":{ @@ -3547,11 +3737,19 @@ "members":{ "arn":{ "shape":"String", - "documentation":"The ARN of the resource.
" + "documentation":"The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
" + }, + "automaticTerminationMode":{ + "shape":"AutomaticTerminationMode", + "documentation":"Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.
When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.
Shows the current backup setting of the session.
" }, "createdAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was created.
" + "documentation":"The ISO timestamp in seconds for when the resource was created.
" }, "createdBy":{ "shape":"String", @@ -3565,6 +3763,10 @@ "shape":"String", "documentation":"The ID of the launch profile used to control access from the streaming session.
" }, + "maxBackupsToRetain":{ + "shape":"StreamConfigurationMaxBackupsToRetain", + "documentation":"The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.
" + }, "ownedBy":{ "shape":"String", "documentation":"The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
" @@ -3573,14 +3775,22 @@ "shape":"StreamingSessionId", "documentation":"The session ID.
" }, + "sessionPersistenceMode":{ + "shape":"SessionPersistenceMode", + "documentation":"Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
The time the session entered START_IN_PROGRESS state.
" + "documentation":"The time the session entered START_IN_PROGRESS state.
The user ID of the user that started the streaming session.
" }, + "startedFromBackupId":{ + "shape":"String", + "documentation":"The backup ID used to restore a streaming session.
" + }, "state":{ "shape":"StreamingSessionState", "documentation":"The current state.
" @@ -3599,7 +3809,7 @@ }, "stoppedAt":{ "shape":"Timestamp", - "documentation":"The time the session entered STOP_IN_PROGRESS state.
" + "documentation":"The time the session entered STOP_IN_PROGRESS state.
A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" }, "terminateAt":{ "shape":"Timestamp", @@ -3619,15 +3829,70 @@ }, "updatedAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was updated.
" + "documentation":"The ISO timestamp in seconds for when the resource was updated.
" }, "updatedBy":{ "shape":"String", "documentation":"The user ID of the user that most recently updated the resource.
" + }, + "volumeConfiguration":{ + "shape":"VolumeConfiguration", + "documentation":"Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
Determine if an EBS volume created from this streaming session will be backed up.
" } }, "documentation":"A streaming session is a virtual workstation created using a particular launch profile.
" }, + "StreamingSessionBackup":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
" + }, + "backupId":{ + "shape":"String", + "documentation":"The ID of the backup.
" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"The ISO timestamp in for when the resource was created.
" + }, + "launchProfileId":{ + "shape":"String", + "documentation":"The ID of the launch profile which allowed the backups for the streaming session.
" + }, + "ownedBy":{ + "shape":"String", + "documentation":"The user ID of the user that owns the streaming session.
" + }, + "sessionId":{ + "shape":"StreamingSessionId", + "documentation":"The streaming session ID for the StreamingSessionBackup.
The status code.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message for the streaming session backup.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" + } + }, + "documentation":"Information about the streaming session backup.
" + }, + "StreamingSessionBackupList":{ + "type":"list", + "member":{"shape":"StreamingSessionBackup"} + }, "StreamingSessionId":{"type":"string"}, "StreamingSessionList":{ "type":"list", @@ -3713,7 +3978,7 @@ "members":{ "createdAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was created.
" + "documentation":"The ISO timestamp in seconds for when the resource was created.
" }, "createdBy":{ "shape":"String", @@ -3721,7 +3986,7 @@ }, "expiresAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource expires.
" + "documentation":"The ISO timestamp in seconds for when the resource expires.
" }, "ownedBy":{ "shape":"String", @@ -3748,6 +4013,7 @@ }, "StreamingSessionStreamExpirationInSeconds":{ "type":"integer", + "box":true, "max":3600, "min":60 }, @@ -3791,7 +4057,7 @@ }, "createdAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was created.
" + "documentation":"The ISO timestamp in seconds for when the resource was created.
" }, "displayName":{ "shape":"StudioDisplayName", @@ -3803,7 +4069,7 @@ }, "ssoClientId":{ "shape":"String", - "documentation":"The IAM Identity Center application client ID used to integrate with IAM Identity Center to enable IAM Identity Center users to log in to Nimble Studio portal.
" + "documentation":"The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
" }, "state":{ "shape":"StudioState", @@ -3835,25 +4101,25 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" }, "updatedAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was updated.
" + "documentation":"The ISO timestamp in seconds for when the resource was updated.
" }, "userRoleArn":{ "shape":"RoleArn", "documentation":"The IAM role that studio users assume when logging in to the Nimble Studio portal.
" } }, - "documentation":"Represents a studio resource.
A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.
When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via IAM Identity Center and your identity source.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.
" + "documentation":"Represents a studio resource.
A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.
When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via IAM Identity Center and your identity source.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.
The ARN of the resource.
" + "documentation":"The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
" }, "configuration":{ "shape":"StudioComponentConfiguration", @@ -3861,7 +4127,7 @@ }, "createdAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was created.
" + "documentation":"The ISO timestamp in seconds for when the resource was created.
" }, "createdBy":{ "shape":"String", @@ -3885,7 +4151,7 @@ }, "runtimeRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "documentation":"An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
" }, "scriptParameters":{ "shape":"StudioComponentScriptParameterKeyValueList", @@ -3893,7 +4159,7 @@ }, "secureInitializationRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
" }, "state":{ "shape":"StudioComponentState", @@ -3917,7 +4183,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" }, "type":{ "shape":"StudioComponentType", @@ -3925,7 +4191,7 @@ }, "updatedAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was updated.
" + "documentation":"The ISO timestamp in seconds for when the resource was updated.
" }, "updatedBy":{ "shape":"String", @@ -3939,7 +4205,7 @@ "members":{ "activeDirectoryConfiguration":{ "shape":"ActiveDirectoryConfiguration", - "documentation":"The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
" + "documentation":"The configuration for a Directory Service for Microsoft Active Directory studio resource.
" }, "computeFarmConfiguration":{ "shape":"ComputeFarmConfiguration", @@ -3978,7 +4244,7 @@ }, "platform":{ "shape":"LaunchProfilePlatform", - "documentation":"The platform of the initialization script, either WINDOWS or LINUX.
" + "documentation":"The platform of the initialization script, either Windows or Linux.
" }, "runContext":{ "shape":"StudioComponentInitializationScriptRunContext", @@ -4035,7 +4301,7 @@ }, "StudioComponentState":{ "type":"string", - "documentation":"The current state of the studio component resource.
While a studio component is being created, modified, or deleted, its state will equal \"CREATE_IN_PROGRESS\", \"UPDATE_IN_PROGRESS\", or \"DELETE_IN_PROGRESS\"
These are called 'transition states'.
No modifications may be made to the studio component while it is in a transition state.
If creation of the resource fails, the state will change to `CREATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why creation failed. The resource in this state will automatically be deleted from your account after a period of time.
If updating the resource fails, the state will change to `UPDATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked.
If deleting the resource fails, the state will change to `DELETE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked. After the resource is deleted successfully, it will change to the \"DELETED\" state. The resource will no longer count against service quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.
", + "documentation":"The current state of the studio component resource.
While a studio component is being created, modified, or deleted, its state will be CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, or DELETE_IN_PROGRESS.
These are called transition states.
No modifications may be made to the studio component while it is in a transition state.
If creation of the resource fails, the state will change to CREATE_FAILED. The resource StatusCode and StatusMessage will provide more information of why creation failed. The resource in this state will automatically be deleted from your account after a period of time.
If updating the resource fails, the state will change to UPDATE_FAILED. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked.
If deleting the resource fails, the state will change to DELETE_FAILED. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked. After the resource is deleted successfully, it will change to the DELETED state. The resource will no longer count against service quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.
The current status of the studio component resource.
When the resource is in the 'READY' state, the status code signals what the last mutation made to the resource was.
When the resource is in a CREATE_FAILED/UPDATE_FAILED/DELETE_FAILED state, the status code signals what went wrong and why the mutation failed.
", + "documentation":"The current status of the studio component resource.
When the resource is in the READY state, the status code signals what the last mutation made to the resource was.
When the resource is in a CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED state, the status code signals what went wrong and why the mutation failed.
The Unix epoch timestamp in seconds for when the resource was created.
" + "documentation":"The ISO timestamp in seconds for when the resource was created.
" }, "createdBy":{ "shape":"String", @@ -4109,7 +4375,7 @@ }, "updatedAt":{ "shape":"Timestamp", - "documentation":"The Unix epoch timestamp in seconds for when the resource was updated.
" + "documentation":"The ISO timestamp in seconds for when the resource was updated.
" }, "updatedBy":{ "shape":"String", @@ -4195,7 +4461,7 @@ "documentation":"The Active Directory Security Identifier for this user, if available.
" } }, - "documentation":"A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.
When you add a user to your studio using the Nimble Studio console, they are given access to the studio's IAM Identity Center application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio's user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.
When you add a user to studio membership with the persona ADMIN, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.
" + "documentation":"A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.
When you add a user to your studio using the Nimble Studio console, they are given access to the studio's IAM Identity Center application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio's user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.
When you add a user to studio membership with the ADMIN persona, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.
" }, "StudioMembershipList":{ "type":"list", @@ -4247,7 +4513,8 @@ "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", - "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS" + "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", + "AWS_STS_REGION_DISABLED" ] }, "TagResourceRequest":{ @@ -4256,13 +4523,13 @@ "members":{ "resourceArn":{ "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the resource you want to add tags to.
", + "documentation":"The Amazon Resource Name (ARN) of the resource you want to add tags to.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"Tags", - "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + "documentation":"A collection of labels, in the form of key-value pairs, that apply to this resource.
" } } }, @@ -4341,14 +4608,14 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" }, "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -4388,7 +4655,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -4399,7 +4666,7 @@ }, "launchProfileId":{ "shape":"String", - "documentation":"The Launch Profile ID.
", + "documentation":"The ID of the launch profile used to control access from the streaming session.
", "location":"uri", "locationName":"launchProfileId" }, @@ -4445,7 +4712,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -4487,7 +4754,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -4514,7 +4781,7 @@ }, "runtimeRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "documentation":"An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
" }, "scriptParameters":{ "shape":"StudioComponentScriptParameterKeyValueList", @@ -4522,7 +4789,7 @@ }, "secureInitializationRoleArn":{ "shape":"RoleArn", - "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "documentation":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
" }, "studioComponentId":{ "shape":"String", @@ -4565,7 +4832,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" @@ -4651,6 +4918,49 @@ "type":"list", "member":{"shape":"ValidationResult"} }, + "VolumeConfiguration":{ + "type":"structure", + "members":{ + "iops":{ + "shape":"VolumeIops", + "documentation":"The number of I/O operations per second for the root volume that is attached to streaming session.
" + }, + "size":{ + "shape":"VolumeSizeInGiB", + "documentation":"The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.
" + }, + "throughput":{ + "shape":"VolumeThroughputInMiBs", + "documentation":"The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.
" + } + }, + "documentation":"Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.
If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
Action: resource-explorer-2:CreateIndex
Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account.
\"Resource\": \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"
Alternatively, you can use \"Resource\": \"*\" to allow the role or user to create an index in any Region.
Action: iam:CreateServiceLinkedRole
Resource: No specific resource (*).
This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.
If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
Action: resource-explorer-2:CreateIndex
Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account.
\"Resource\": \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"
Alternatively, you can use \"Resource\": \"*\" to allow the role or user to create an index in any Region.
Action: iam:CreateServiceLinkedRole
Resource: No specific resource (*).
This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.
Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.
Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.
If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.
Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
AGGREGATOR index type
The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.
LOCAL index type
The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.
After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.
Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
AGGREGATOR index type
The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.
LOCAL index type
The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.
After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.
If this index is Type=AGGREGATOR, then this response value contains a list of the Amazon Web Services Regions that replicate their content to the index in this Region. Not present for a local index.
This response value is present only if this index is Type=AGGREGATOR.
A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
" }, "ReplicatingTo":{ "shape":"RegionList", - "documentation":"Identifies the Amazon Web Services Region that has an index set to Type=AGGREGATOR, if one exists. If it does, then the Region you called this operation in replicates its index information to the Region specified in this response value. Not present if there isn't an aggregator index in the account.
This response value is present only if this index is Type=LOCAL.
The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
" }, "State":{ "shape":"IndexState", - "documentation":"Indicates the current state of the index in this Amazon Web Services Region.
" + "documentation":"The current state of the index in this Amazon Web Services Region.
" }, "Tags":{ "shape":"TagMap", @@ -639,7 +639,7 @@ }, "Type":{ "shape":"IndexType", - "documentation":"Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
" + "documentation":"The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
" } } }, @@ -1342,5 +1342,5 @@ "pattern":"^[a-zA-Z0-9\\-]{1,64}$" } }, - "documentation":"Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.
Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.
You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.
For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.
" + "documentation":"Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.
Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.
You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.
For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.
" } diff --git a/services/resourcegroups/pom.xml b/services/resourcegroups/pom.xml index d0a760ea225e..ead5c64875a8 100644 --- a/services/resourcegroups/pom.xml +++ b/services/resourcegroups/pom.xml @@ -20,7 +20,7 @@Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.
If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes.
Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
Creates a delegation signer (DS) record in the registry zone for this domain name.
Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC signing in the Route 53 developer guide.
" + }, "CancelDomainTransferToAnotherAwsAccount":{ "name":"CancelDomainTransferToAnotherAwsAccount", "http":{ @@ -133,6 +151,23 @@ ], "documentation":"This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
Deletes a delegation signer (DS) record in the registry zone for this domain name.
" + }, "EnableDomainAutoRenew":{ "name":"EnableDomainAutoRenew", "http":{ @@ -276,6 +311,20 @@ ], "documentation":"This operation returns all of the tags that are associated with the specified domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
" }, + "PushDomain":{ + "name":"PushDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PushDomainRequest"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"Moves a domain from Amazon Web Services to another registrar.
Supported actions:
Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.
This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
Charges your Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables auto renew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
Charges your Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.
" }, + "ResendOperationAuthorization":{ + "name":"ResendOperationAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResendOperationAuthorizationRequest"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"Resend the form of authorization email for this operation.
" + }, "RetrieveDomainAuthCode":{ "name":"RetrieveDomainAuthCode", "http":{ @@ -353,7 +414,7 @@ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"} ], - "documentation":"This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
" + "documentation":"This operation returns the authorization code for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
" }, "TransferDomain":{ "name":"TransferDomain", @@ -404,7 +465,7 @@ {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], - "documentation":"This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.
If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
" + "documentation":"This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.
If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the operation. If the request is not completed successfully, the domain registrant will be notified by email.
" }, "UpdateDomainContactPrivacy":{ "name":"UpdateDomainContactPrivacy", @@ -508,6 +569,32 @@ "type":"string", "max":255 }, + "AssociateDelegationSignerToDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SigningAttributes" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The name of the domain.
" + }, + "SigningAttributes":{ + "shape":"DnssecSigningAttributes", + "documentation":"The information about a key, including the algorithm, public key-value, and flags.
" + } + } + }, + "AssociateDelegationSignerToDomainResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"The identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" + } + } + }, "BillingRecord":{ "type":"structure", "members":{ @@ -577,7 +664,6 @@ }, "CheckDomainAvailabilityResponse":{ "type":"structure", - "required":["Availability"], "members":{ "Availability":{ "shape":"DomainAvailability", @@ -603,7 +689,6 @@ }, "CheckDomainTransferabilityResponse":{ "type":"structure", - "required":["Transferability"], "members":{ "Transferability":{ "shape":"DomainTransferability", @@ -616,6 +701,24 @@ "type":"string", "max":255 }, + "Consent":{ + "type":"structure", + "required":[ + "MaxPrice", + "Currency" + ], + "members":{ + "MaxPrice":{ + "shape":"Price", + "documentation":"Maximum amount the customer agreed to accept.
" + }, + "Currency":{ + "shape":"Currency", + "documentation":" Currency for the MaxPrice.
Customer's consent for the owner change request.
" + }, "ContactDetail":{ "type":"structure", "members":{ @@ -1030,7 +1133,6 @@ }, "DisableDomainTransferLockResponse":{ "type":"structure", - "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", @@ -1039,6 +1141,100 @@ }, "documentation":"The DisableDomainTransferLock response includes the following element.
" }, + "DisassociateDelegationSignerFromDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Id" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"Name of the domain.
" + }, + "Id":{ + "shape":"String", + "documentation":"An internal identification number assigned to each DS record after it’s created. You can retrieve it as part of DNSSEC information returned by GetDomainDetail.
" + } + } + }, + "DisassociateDelegationSignerFromDomainResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" + } + } + }, + "DnssecKey":{ + "type":"structure", + "members":{ + "Algorithm":{ + "shape":"NullableInteger", + "documentation":"The number of the public key’s cryptographic algorithm according to an IANA assignment.
If Route 53 is your DNS service, set this to 13.
For more information about enabling DNSSEC signing, see Enabling DNSSEC signing and establishing a chain of trust.
" + }, + "Flags":{ + "shape":"NullableInteger", + "documentation":"Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS provider isn't Route 53 and you don’t have KSK available.
If you have KSK and ZSK keys, always use KSK to create a delegations signer (DS) record. If you have ZSK keys only – use ZSK to create a DS record.
" + }, + "PublicKey":{ + "shape":"DnssecPublicKey", + "documentation":"The base64-encoded public key part of the key pair that is passed to the registry .
" + }, + "DigestType":{ + "shape":"NullableInteger", + "documentation":"The number of the DS digest algorithm according to an IANA assignment.
For more information, see IANA for DNSSEC Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms.
" + }, + "Digest":{ + "shape":"String", + "documentation":"The delegation signer digest.
Digest is calculated from the public key provided using specified digest algorithm and this digest is the actual value returned from the registry nameservers as the value of DS records.
" + }, + "KeyTag":{ + "shape":"NullableInteger", + "documentation":"A numeric identification of the DNSKEY record referred to by this DS record.
" + }, + "Id":{ + "shape":"String", + "documentation":"An ID assigned to each DS record created by AssociateDelegationSignerToDomain.
" + } + }, + "documentation":"Information about the DNSSEC key.
You get this from your DNS provider and then give it to Route 53 (by using AssociateDelegationSignerToDomain) to pass it to the registry to establish the chain of trust.
" + }, + "DnssecKeyList":{ + "type":"list", + "member":{"shape":"DnssecKey"} + }, + "DnssecLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":" This error is returned if you call AssociateDelegationSignerToDomain when the specified domain has reached the maximum number of DS records. You can't add any additional DS records unless you delete an existing one first.
Algorithm which was used to generate the digest from the public key.
" + }, + "Flags":{ + "shape":"NullableInteger", + "documentation":"Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS provider isn't Route 53 and you don’t have KSK available.
If you have KSK and ZSK keys, always use KSK to create a delegations signer (DS) record. If you have ZSK keys only – use ZSK to create a DS record.
" + }, + "PublicKey":{ + "shape":"DnssecPublicKey", + "documentation":"The base64-encoded public key part of the key pair that is passed to the registry.
" + } + }, + "documentation":"Information about a delegation signer (DS) record that was created in the registry by AssociateDelegationSignerToDomain.
" + }, "DomainAuthCode":{ "type":"string", "max":1024, @@ -1136,7 +1332,6 @@ }, "DomainSummary":{ "type":"structure", - "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", @@ -1216,7 +1411,6 @@ }, "EnableDomainTransferLockResponse":{ "type":"structure", - "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", @@ -1235,7 +1429,7 @@ "members":{ "Name":{ "shape":"ExtraParamName", - "documentation":"The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:
AU_ID_NUMBER
AU_ID_TYPE
Valid values include the following:
ABN (Australian business number)
ACN (Australian company number)
TM (Trademark number)
BRAND_NUMBER
CA_BUSINESS_ENTITY_TYPE
Valid values include the following:
BANK (Bank)
COMMERCIAL_COMPANY (Commercial company)
COMPANY (Company)
COOPERATION (Cooperation)
COOPERATIVE (Cooperative)
COOPRIX (Cooprix)
CORP (Corporation)
CREDIT_UNION (Credit union)
FOMIA (Federation of mutual insurance associations)
INC (Incorporated)
LTD (Limited)
LTEE (Limitée)
LLC (Limited liability corporation)
LLP (Limited liability partnership)
LTE (Lte.)
MBA (Mutual benefit association)
MIC (Mutual insurance company)
NFP (Not-for-profit corporation)
SA (S.A.)
SAVINGS_COMPANY (Savings company)
SAVINGS_UNION (Savings union)
SARL (Société à responsabilité limitée)
TRUST (Trust)
ULC (Unlimited liability corporation)
CA_LEGAL_TYPE
When ContactType is PERSON, valid values include the following:
ABO (Aboriginal Peoples indigenous to Canada)
CCT (Canadian citizen)
LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
RES (Permanent resident of Canada)
When ContactType is a value other than PERSON, valid values include the following:
ASS (Canadian unincorporated association)
CCO (Canadian corporation)
EDU (Canadian educational institution)
GOV (Government or government entity in Canada)
HOP (Canadian Hospital)
INB (Indian Band recognized by the Indian Act of Canada)
LAM (Canadian Library, Archive, or Museum)
MAJ (Her/His Majesty the Queen/King)
OMK (Official mark registered in Canada)
PLT (Canadian Political Party)
PRT (Partnership Registered in Canada)
TDM (Trademark registered in Canada)
TRD (Canadian Trade Union)
TRS (Trust established in Canada)
ES_IDENTIFICATION
The value of ES_IDENTIFICATION depends on the following values:
The value of ES_LEGAL_FORM
The value of ES_IDENTIFICATION_TYPE
If ES_LEGAL_FORM is any value other than INDIVIDUAL:
Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])
Example: B12345678
If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:
If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):
Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])
Example: 12345678M
If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):
Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])
Example: Y1234567X
If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):
Specify a passport number, drivers license number, or national identity card number
ES_IDENTIFICATION_TYPE
Valid values include the following:
DNI_AND_NIF (For Spanish contacts)
NIE (For foreigners with legal residence)
OTHER (For contacts outside of Spain)
ES_LEGAL_FORM
Valid values include the following:
ASSOCIATION
CENTRAL_GOVERNMENT_BODY
CIVIL_SOCIETY
COMMUNITY_OF_OWNERS
COMMUNITY_PROPERTY
CONSULATE
COOPERATIVE
DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
ECONOMIC_INTEREST_GROUP
EMBASSY
ENTITY_MANAGING_NATURAL_AREAS
FARM_PARTNERSHIP
FOUNDATION
GENERAL_AND_LIMITED_PARTNERSHIP
GENERAL_PARTNERSHIP
INDIVIDUAL
LIMITED_COMPANY
LOCAL_AUTHORITY
LOCAL_PUBLIC_ENTITY
MUTUAL_INSURANCE_COMPANY
NATIONAL_PUBLIC_ENTITY
ORDER_OR_RELIGIOUS_INSTITUTION
OTHERS (Only for contacts outside of Spain)
POLITICAL_PARTY
PROFESSIONAL_ASSOCIATION
PUBLIC_LAW_ASSOCIATION
PUBLIC_LIMITED_COMPANY
REGIONAL_GOVERNMENT_BODY
REGIONAL_PUBLIC_ENTITY
SAVINGS_BANK
SPANISH_OFFICE
SPORTS_ASSOCIATION
SPORTS_FEDERATION
SPORTS_LIMITED_COMPANY
TEMPORARY_ALLIANCE_OF_ENTERPRISES
TRADE_UNION
WORKER_OWNED_COMPANY
WORKER_OWNED_LIMITED_COMPANY
EU_COUNTRY_OF_CITIZENSHIP
BIRTH_DATE_IN_YYYY_MM_DD
FI_BUSINESS_NUMBER
FI_ID_NUMBER
FI_NATIONALITY
Valid values include the following:
FINNISH
NOT_FINNISH
FI_ORGANIZATION_TYPE
Valid values include the following:
COMPANY
CORPORATION
GOVERNMENT
INSTITUTION
POLITICAL_PARTY
PUBLIC_COMMUNITY
TOWNSHIP
BIRTH_CITY
BIRTH_COUNTRY
BIRTH_DATE_IN_YYYY_MM_DD
BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. If the contact was born somewhere other than France or its overseas departments, specify 99. For more information, including a list of departments and the corresponding INSEE numbers, see the Wikipedia entry Departments of France.
BRAND_NUMBER
IT_NATIONALITY
IT_PIN
IT_REGISTRANT_ENTITY_TYPE
Valid values include the following:
FOREIGNERS
FREELANCE_WORKERS (Freelance workers and professionals)
ITALIAN_COMPANIES (Italian companies and one-person companies)
NON_PROFIT_ORGANIZATIONS
OTHER_SUBJECTS
PUBLIC_ORGANIZATIONS
BIRTH_DATE_IN_YYYY_MM_DD
RU_PASSPORT_DATA
BIRTH_COUNTRY
SE_ID_NUMBER
SG_ID_NUMBER
UK_CONTACT_TYPE
Valid values include the following:
CRC (UK Corporation by Royal Charter)
FCORP (Non-UK Corporation)
FIND (Non-UK Individual, representing self)
FOTHER (Non-UK Entity that does not fit into any other category)
GOV (UK Government Body)
IND (UK Individual (representing self))
IP (UK Industrial/Provident Registered Company)
LLP (UK Limited Liability Partnership)
LTD (UK Limited Company)
OTHER (UK Entity that does not fit into any other category)
PLC (UK Public Limited Company)
PTNR (UK Partnership)
RCHAR (UK Registered Charity)
SCH (UK School)
STAT (UK Statutory Body)
STRA (UK Sole Trader)
UK_COMPANY_NUMBER
In addition, many TLDs require a VAT_NUMBER.
The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:
AU_ID_NUMBER
AU_ID_TYPE
Valid values include the following:
ABN (Australian business number)
ACN (Australian company number)
TM (Trademark number)
BRAND_NUMBER
CA_BUSINESS_ENTITY_TYPE
Valid values include the following:
BANK (Bank)
COMMERCIAL_COMPANY (Commercial company)
COMPANY (Company)
COOPERATION (Cooperation)
COOPERATIVE (Cooperative)
COOPRIX (Cooprix)
CORP (Corporation)
CREDIT_UNION (Credit union)
FOMIA (Federation of mutual insurance associations)
INC (Incorporated)
LTD (Limited)
LTEE (Limitée)
LLC (Limited liability corporation)
LLP (Limited liability partnership)
LTE (Lte.)
MBA (Mutual benefit association)
MIC (Mutual insurance company)
NFP (Not-for-profit corporation)
SA (S.A.)
SAVINGS_COMPANY (Savings company)
SAVINGS_UNION (Savings union)
SARL (Société à responsabilité limitée)
TRUST (Trust)
ULC (Unlimited liability corporation)
CA_LEGAL_TYPE
When ContactType is PERSON, valid values include the following:
ABO (Aboriginal Peoples indigenous to Canada)
CCT (Canadian citizen)
LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
RES (Permanent resident of Canada)
When ContactType is a value other than PERSON, valid values include the following:
ASS (Canadian unincorporated association)
CCO (Canadian corporation)
EDU (Canadian educational institution)
GOV (Government or government entity in Canada)
HOP (Canadian Hospital)
INB (Indian Band recognized by the Indian Act of Canada)
LAM (Canadian Library, Archive, or Museum)
MAJ (Her/His Majesty the Queen/King)
OMK (Official mark registered in Canada)
PLT (Canadian Political Party)
PRT (Partnership Registered in Canada)
TDM (Trademark registered in Canada)
TRD (Canadian Trade Union)
TRS (Trust established in Canada)
ES_IDENTIFICATION
The value of ES_IDENTIFICATION depends on the following values:
The value of ES_LEGAL_FORM
The value of ES_IDENTIFICATION_TYPE
If ES_LEGAL_FORM is any value other than INDIVIDUAL:
Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])
Example: B12345678
If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:
If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):
Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])
Example: 12345678M
If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):
Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])
Example: Y1234567X
If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):
Specify a passport number, drivers license number, or national identity card number
ES_IDENTIFICATION_TYPE
Valid values include the following:
DNI_AND_NIF (For Spanish contacts)
NIE (For foreigners with legal residence)
OTHER (For contacts outside of Spain)
ES_LEGAL_FORM
Valid values include the following:
ASSOCIATION
CENTRAL_GOVERNMENT_BODY
CIVIL_SOCIETY
COMMUNITY_OF_OWNERS
COMMUNITY_PROPERTY
CONSULATE
COOPERATIVE
DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
ECONOMIC_INTEREST_GROUP
EMBASSY
ENTITY_MANAGING_NATURAL_AREAS
FARM_PARTNERSHIP
FOUNDATION
GENERAL_AND_LIMITED_PARTNERSHIP
GENERAL_PARTNERSHIP
INDIVIDUAL
LIMITED_COMPANY
LOCAL_AUTHORITY
LOCAL_PUBLIC_ENTITY
MUTUAL_INSURANCE_COMPANY
NATIONAL_PUBLIC_ENTITY
ORDER_OR_RELIGIOUS_INSTITUTION
OTHERS (Only for contacts outside of Spain)
POLITICAL_PARTY
PROFESSIONAL_ASSOCIATION
PUBLIC_LAW_ASSOCIATION
PUBLIC_LIMITED_COMPANY
REGIONAL_GOVERNMENT_BODY
REGIONAL_PUBLIC_ENTITY
SAVINGS_BANK
SPANISH_OFFICE
SPORTS_ASSOCIATION
SPORTS_FEDERATION
SPORTS_LIMITED_COMPANY
TEMPORARY_ALLIANCE_OF_ENTERPRISES
TRADE_UNION
WORKER_OWNED_COMPANY
WORKER_OWNED_LIMITED_COMPANY
EU_COUNTRY_OF_CITIZENSHIP
BIRTH_DATE_IN_YYYY_MM_DD
FI_BUSINESS_NUMBER
FI_ID_NUMBER
FI_NATIONALITY
Valid values include the following:
FINNISH
NOT_FINNISH
FI_ORGANIZATION_TYPE
Valid values include the following:
COMPANY
CORPORATION
GOVERNMENT
INSTITUTION
POLITICAL_PARTY
PUBLIC_COMMUNITY
TOWNSHIP
BIRTH_CITY
BIRTH_COUNTRY
BIRTH_DATE_IN_YYYY_MM_DD
BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. If the contact was born somewhere other than France or its overseas departments, specify 99. For more information, including a list of departments and the corresponding INSEE numbers, see the Wikipedia entry Departments of France.
BRAND_NUMBER
IT_NATIONALITY
IT_PIN
IT_REGISTRANT_ENTITY_TYPE
Valid values include the following:
FOREIGNERS
FREELANCE_WORKERS (Freelance workers and professionals)
ITALIAN_COMPANIES (Italian companies and one-person companies)
NON_PROFIT_ORGANIZATIONS
OTHER_SUBJECTS
PUBLIC_ORGANIZATIONS
BIRTH_DATE_IN_YYYY_MM_DD
RU_PASSPORT_DATA
BIRTH_COUNTRY
SE_ID_NUMBER
SG_ID_NUMBER
UK_CONTACT_TYPE
Valid values include the following:
CRC (UK Corporation by Royal Charter)
FCORP (Non-UK Corporation)
FIND (Non-UK Individual, representing self)
FOTHER (Non-UK Entity that does not fit into any other category)
GOV (UK Government Body)
IND (UK Individual (representing self))
IP (UK Industrial/Provident Registered Company)
LLP (UK Limited Liability Partnership)
LTD (UK Limited Company)
OTHER (UK Entity that does not fit into any other category)
PLC (UK Public Limited Company)
PTNR (UK Partnership)
RCHAR (UK Registered Charity)
SCH (UK School)
STAT (UK Statutory Body)
STRA (UK Sole Trader)
UK_COMPANY_NUMBER
In addition, many TLDs require a VAT_NUMBER.
The name of the domain.
" + "documentation":"The name servers of the domain.
" }, "AutoRenew":{ "shape":"Boolean", @@ -1447,6 +1635,10 @@ "StatusList":{ "shape":"DomainStatusList", "documentation":"An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)
A complex type that contains information about the DNSSEC configuration.
" } }, "documentation":"The GetDomainDetail response includes the following elements.
" @@ -1519,6 +1711,14 @@ "SubmittedDate":{ "shape":"Timestamp", "documentation":"The date when the request was submitted.
" + }, + "LastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"The date when the operation was last updated.
" + }, + "StatusFlag":{ + "shape":"StatusFlag", + "documentation":"Lists any outstanding operations that require customer action. Valid values are:
PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.
The GetOperationDetail response includes the following elements.
" @@ -1549,6 +1749,11 @@ "exception":true }, "InvoiceId":{"type":"string"}, + "Label":{ + "type":"string", + "max":255, + "min":1 + }, "LangCode":{ "type":"string", "max":3 @@ -1584,7 +1789,6 @@ }, "ListDomainsResponse":{ "type":"structure", - "required":["Domains"], "members":{ "Domains":{ "shape":"DomainSummaryList", @@ -1611,13 +1815,28 @@ "MaxItems":{ "shape":"PageMaxItems", "documentation":"Number of domains to be returned.
Default: 20
" + }, + "Status":{ + "shape":"OperationStatusList", + "documentation":"The status of the operations.
" + }, + "Type":{ + "shape":"OperationTypeList", + "documentation":"An arrays of the domains operation types.
" + }, + "SortBy":{ + "shape":"ListOperationsSortAttributeName", + "documentation":"The sort type for returned values.
" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"The sort order ofr returned values, either ascending or descending.
" } }, "documentation":"The ListOperations request includes the following elements.
" }, "ListOperationsResponse":{ "type":"structure", - "required":["Operations"], "members":{ "Operations":{ "shape":"OperationSummaryList", @@ -1630,6 +1849,10 @@ }, "documentation":"The ListOperations response includes the following elements.
" }, + "ListOperationsSortAttributeName":{ + "type":"string", + "enum":["SubmittedDate"] + }, "ListPricesRequest":{ "type":"structure", "members":{ @@ -1649,7 +1872,6 @@ }, "ListPricesResponse":{ "type":"structure", - "required":["Prices"], "members":{ "Prices":{ "shape":"DomainPriceList", @@ -1674,7 +1896,6 @@ }, "ListTagsForDomainResponse":{ "type":"structure", - "required":["TagList"], "members":{ "TagList":{ "shape":"TagList", @@ -1696,12 +1917,13 @@ "documentation":"Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
Constraints: The list can contain only one IPv4 and one IPv6 address.
" } }, - "documentation":"Nameserver includes the following elements.
" + "documentation":"Name server includes the following elements.
" }, "NameserverList":{ "type":"list", "member":{"shape":"Nameserver"} }, + "NullableInteger":{"type":"integer"}, "OperationId":{ "type":"string", "max":255 @@ -1727,14 +1949,13 @@ "FAILED" ] }, + "OperationStatusList":{ + "type":"list", + "member":{"shape":"OperationStatus"}, + "max":5 + }, "OperationSummary":{ "type":"structure", - "required":[ - "OperationId", - "Status", - "Type", - "SubmittedDate" - ], "members":{ "OperationId":{ "shape":"OperationId", @@ -1751,6 +1972,22 @@ "SubmittedDate":{ "shape":"Timestamp", "documentation":"The date when the request was submitted.
" + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"Name of the domain.
" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"Message about the operation.
" + }, + "StatusFlag":{ + "shape":"StatusFlag", + "documentation":"Automatically checks whether there are no outstanding operations on domains that need customer attention.
Valid values are:
PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.
The date when the last change was made in Unix time format and Coordinated Universal Time (UTC).
" } }, "documentation":"OperationSummary includes the following elements.
" @@ -1782,6 +2019,11 @@ "INTERNAL_TRANSFER_IN_DOMAIN" ] }, + "OperationTypeList":{ + "type":"list", + "member":{"shape":"OperationType"}, + "max":18 + }, "Operator":{ "type":"string", "enum":[ @@ -1817,6 +2059,23 @@ }, "documentation":"Currency-specific price information.
" }, + "PushDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Target" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"Name of the domain.
" + }, + "Target":{ + "shape":"Label", + "documentation":"New IPS tag for the domain.
" + } + } + }, "ReachabilityStatus":{ "type":"string", "enum":[ @@ -1849,7 +2108,7 @@ }, "AutoRenew":{ "shape":"Boolean", - "documentation":"Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Default: true
Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged.
Default: true
Operation ID.
" + } + } + }, "RetrieveDomainAuthCodeRequest":{ "type":"structure", "required":["DomainName"], @@ -1986,7 +2253,6 @@ }, "RetrieveDomainAuthCodeResponse":{ "type":"structure", - "required":["AuthCode"], "members":{ "AuthCode":{ "shape":"DomainAuthCode", @@ -2024,6 +2290,16 @@ "type":"string", "max":255 }, + "StatusFlag":{ + "type":"string", + "enum":[ + "PENDING_ACCEPTANCE", + "PENDING_CUSTOMER_ACTION", + "PENDING_AUTHORIZATION", + "PENDING_PAYMENT_VERIFICATION", + "PENDING_SUPPORT_CASE" + ] + }, "String":{"type":"string"}, "TLDRulesViolation":{ "type":"structure", @@ -2072,7 +2348,7 @@ "TldName":{ "type":"string", "max":255, - "min":1 + "min":2 }, "TransferDomainRequest":{ "type":"structure", @@ -2106,7 +2382,7 @@ }, "AutoRenew":{ "shape":"Boolean", - "documentation":"Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Default: true
" + "documentation":"Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged.
Default: true
" }, "AdminContact":{ "shape":"ContactDetail", @@ -2137,7 +2413,6 @@ }, "TransferDomainResponse":{ "type":"structure", - "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", @@ -2180,11 +2455,14 @@ }, "Transferable":{ "type":"string", - "documentation":"Whether the domain name can be transferred to Route 53.
You can transfer only domains that have a value of TRANSFERABLE for Transferable.
Valid values:
The domain name can be transferred to Route 53.
The domain name can't be transferred to Route 53.
Reserved for future use.
Whether the domain name can be transferred to Route 53.
You can transfer only domains that have a value of TRANSFERABLE or Transferable.
Valid values:
The domain name can be transferred to Route 53.
The domain name can't be transferred to Route 53.
Reserved for future use.
The domain already exists in the current Amazon Web Services account.
the domain exists in another Amazon Web Services account.
Premium domain transfer is not supported.
Provides detailed contact information.
" + }, + "Consent":{ + "shape":"Consent", + "documentation":"Customer's consent for the owner change request.
" } }, "documentation":"The UpdateDomainContact request includes the following elements.
" }, "UpdateDomainContactResponse":{ "type":"structure", - "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", @@ -2291,7 +2571,6 @@ }, "UpdateDomainNameserversResponse":{ "type":"structure", - "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", diff --git a/services/route53recoverycluster/pom.xml b/services/route53recoverycluster/pom.xml index 9a163200cd9b..5b3cc0f6e752 100644 --- a/services/route53recoverycluster/pom.xml +++ b/services/route53recoverycluster/pom.xml @@ -21,7 +21,7 @@Creates an SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
" + "documentation":"Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
" }, "CreateFeatureGroup":{ "name":"CreateFeatureGroup", @@ -4904,7 +4904,7 @@ "members":{ "MetricName":{ "shape":"AutoMLMetricEnum", - "documentation":"The name of the objective metric used to measure the predictive quality of a machine learning system. This metric is optimized during training to provide the best estimate for model parameter values from data.
Here are the options:
MSE: The mean squared error (MSE) is the average of the squared differences between the predicted and actual values. It is used for regression. MSE values are always positive: the better a model is at predicting the actual values, the smaller the MSE value is. When the data contains outliers, they tend to dominate the MSE, which might cause subpar prediction performance.
Accuracy: The ratio of the number of correctly classified items to the total number of (correctly and incorrectly) classified items. It is used for binary and multiclass classification. It measures how close the predicted class values are to the actual values. Accuracy values vary between zero and one: one indicates perfect accuracy and zero indicates perfect inaccuracy.
F1: The F1 score is the harmonic mean of the precision and recall. It is used for binary classification into classes traditionally referred to as positive and negative. Predictions are said to be true when they match their actual (correct) class and false when they do not. Precision is the ratio of the true positive predictions to all positive predictions (including the false positives) in a data set and measures the quality of the prediction when it predicts the positive class. Recall (or sensitivity) is the ratio of the true positive predictions to all actual positive instances and measures how completely a model predicts the actual class members in a data set. The standard F1 score weighs precision and recall equally. But which metric is paramount typically depends on specific aspects of a problem. F1 scores vary between zero and one: one indicates the best possible performance and zero the worst.
AUC: The area under the curve (AUC) metric is used to compare and evaluate binary classification by algorithms such as logistic regression that return probabilities. A threshold is needed to map the probabilities into classifications. The relevant curve is the receiver operating characteristic curve that plots the true positive rate (TPR) of predictions (or recall) against the false positive rate (FPR) as a function of the threshold value, above which a prediction is considered positive. Increasing the threshold results in fewer false positives but more false negatives. AUC is the area under this receiver operating characteristic curve and so provides an aggregated measure of the model performance across all possible classification thresholds. The AUC score can also be interpreted as the probability that a randomly selected positive data point is more likely to be predicted positive than a randomly selected negative example. AUC scores vary between zero and one: a score of one indicates perfect accuracy and a score of one half indicates that the prediction is not better than a random classifier. Values under one half predict less accurately than a random predictor. But such consistently bad predictors can simply be inverted to obtain better than random predictors.
F1macro: The F1macro score applies F1 scoring to multiclass classification. In this context, you have multiple classes to predict. You just calculate the precision and recall for each class as you did for the positive class in binary classification. Then, use these values to calculate the F1 score for each class and average them to obtain the F1macro score. F1macro scores vary between zero and one: one indicates the best possible performance and zero the worst.
If you do not specify a metric explicitly, the default behavior is to automatically use:
MSE: for regression.
F1: for binary classification
Accuracy: for multiclass classification.
The name of the objective metric used to measure the predictive quality of a machine learning system. This metric is optimized during training to provide the best estimate for model parameter values from data.
Here are the options:
The ratio of the number of correctly classified items to the total number of (correctly and incorrectly) classified items. It is used for both binary and multiclass classification. Accuracy measures how close the predicted class values are to the actual values. Values for accuracy metrics vary between zero (0) and one (1). A value of 1 indicates perfect accuracy, and 0 indicates perfect inaccuracy.
The area under the curve (AUC) metric is used to compare and evaluate binary classification by algorithms that return probabilities, such as logistic regression. To map the probabilities into classifications, these are compared against a threshold value.
The relevant curve is the receiver operating characteristic curve (ROC curve). The ROC curve plots the true positive rate (TPR) of predictions (or recall) against the false positive rate (FPR) as a function of the threshold value, above which a prediction is considered positive. Increasing the threshold results in fewer false positives, but more false negatives.
AUC is the area under this ROC curve. Therefore, AUC provides an aggregated measure of the model performance across all possible classification thresholds. AUC scores vary between 0 and 1. A score of 1 indicates perfect accuracy, and a score of one half (0.5) indicates that the prediction is not better than a random classifier.
BalancedAccuracy is a metric that measures the ratio of accurate predictions to all predictions. This ratio is calculated after normalizing true positives (TP) and true negatives (TN) by the total number of positive (P) and negative (N) values. It is used in both binary and multiclass classification and is defined as follows: 0.5*((TP/P)+(TN/N)), with values ranging from 0 to 1. BalancedAccuracy gives a better measure of accuracy when the number of positives or negatives differ greatly from each other in an imbalanced dataset. For example, when only 1% of email is spam.
The F1 score is the harmonic mean of the precision and recall, defined as follows: F1 = 2 * (precision * recall) / (precision + recall). It is used for binary classification into classes traditionally referred to as positive and negative. Predictions are said to be true when they match their actual (correct) class, and false when they do not.
Precision is the ratio of the true positive predictions to all positive predictions, and it includes the false positives in a dataset. Precision measures the quality of the prediction when it predicts the positive class.
Recall (or sensitivity) is the ratio of the true positive predictions to all actual positive instances. Recall measures how completely a model predicts the actual class members in a dataset.
F1 scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.
The F1macro score applies F1 scoring to multiclass classification problems. It does this by calculating the precision and recall, and then taking their harmonic mean to calculate the F1 score for each class. Lastly, the F1macro averages the individual scores to obtain the F1macro score. F1macro scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.
The mean absolute error (MAE) is a measure of how different the predicted and actual values are, when they're averaged over all values. MAE is commonly used in regression analysis to understand model prediction error. If there is linear regression, MAE represents the average distance from a predicted line to the actual value. MAE is defined as the sum of absolute errors divided by the number of observations. Values range from 0 to infinity, with smaller numbers indicating a better model fit to the data.
The mean squared error (MSE) is the average of the squared differences between the predicted and actual values. It is used for regression. MSE values are always positive. The better a model is at predicting the actual values, the smaller the MSE value is
Precision measures how well an algorithm predicts the true positives (TP) out of all of the positives that it identifies. It is defined as follows: Precision = TP/(TP+FP), with values ranging from zero (0) to one (1), and is used in binary classification. Precision is an important metric when the cost of a false positive is high. For example, the cost of a false positive is very high if an airplane safety system is falsely deemed safe to fly. A false positive (FP) reflects a positive prediction that is actually negative in the data.
The precision macro computes precision for multiclass classification problems. It does this by calculating precision for each class and averaging scores to obtain precision for several classes. PrecisionMacro scores range from zero (0) to one (1). Higher scores reflect the model's ability to predict true positives (TP) out of all of the positives that it identifies, averaged across multiple classes.
R2, also known as the coefficient of determination, is used in regression to quantify how much a model can explain the variance of a dependent variable. Values range from one (1) to negative one (-1). Higher numbers indicate a higher fraction of explained variability. R2 values close to zero (0) indicate that very little of the dependent variable can be explained by the model. Negative values indicate a poor fit and that the model is outperformed by a constant function. For linear regression, this is a horizontal line.
Recall measures how well an algorithm correctly predicts all of the true positives (TP) in a dataset. A true positive is a positive prediction that is also an actual positive value in the data. Recall is defined as follows: Recall = TP/(TP+FN), with values ranging from 0 to 1. Higher scores reflect a better ability of the model to predict true positives (TP) in the data, and is used in binary classification.
Recall is important when testing for cancer because it's used to find all of the true positives. A false positive (FP) reflects a positive prediction that is actually negative in the data. It is often insufficient to measure only recall, because predicting every output as a true positive will yield a perfect recall score.
The RecallMacro computes recall for multiclass classification problems by calculating recall for each class and averaging scores to obtain recall for several classes. RecallMacro scores range from 0 to 1. Higher scores reflect the model's ability to predict true positives (TP) in a dataset. Whereas, a true positive reflects a positive prediction that is also an actual positive value in the data. It is often insufficient to measure only recall, because predicting every output as a true positive will yield a perfect recall score.
Root mean squared error (RMSE) measures the square root of the squared difference between predicted and actual values, and it's averaged over all values. It is used in regression analysis to understand model prediction error. It's an important metric to indicate the presence of large model errors and outliers. Values range from zero (0) to infinity, with smaller numbers indicating a better model fit to the data. RMSE is dependent on scale, and should not be used to compare datasets of different sizes.
If you do not specify a metric explicitly, the default behavior is to automatically use:
MSE: for regression.
F1: for binary classification
Accuracy: for multiclass classification.
Specifies a metric to minimize or maximize as the objective of a job.
" @@ -5024,7 +5024,15 @@ "MSE", "F1", "F1macro", - "AUC" + "AUC", + "RMSE", + "MAE", + "R2", + "BalancedAccuracy", + "Precision", + "PrecisionMacro", + "Recall", + "RecallMacro" ] }, "AutoMLMetricExtendedEnum":{ @@ -10736,7 +10744,7 @@ }, "BestCandidate":{ "shape":"AutoMLCandidate", - "documentation":"Returns the job's best AutoMLCandidate.
The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
" }, "AutoMLJobStatus":{ "shape":"AutoMLJobStatus", @@ -14052,7 +14060,7 @@ }, "Sources":{ "shape":"TrialComponentSources", - "documentation":"A list of the Amazon Resource Name (ARN) and, if applicable, job type for multiple sources of an experiment run.
" + "documentation":"A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
" } } }, @@ -15678,7 +15686,7 @@ "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", - "documentation":"The name of an existing experiment to associate the trial component with.
" + "documentation":"The name of an existing experiment to associate with the trial component.
" }, "TrialName":{ "shape":"ExperimentEntityName", @@ -15690,7 +15698,7 @@ }, "RunName":{ "shape":"ExperimentEntityName", - "documentation":"The name of the experiment run to associate the trial component with.
" + "documentation":"The name of the experiment run to associate with the trial component.
" } }, "documentation":"Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
" @@ -17308,7 +17316,7 @@ }, "ParameterRanges":{ "shape":"ParameterRanges", - "documentation":"The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against .your chosen objective metric.
" + "documentation":"The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.
" }, "TrainingJobEarlyStoppingType":{ "shape":"TrainingJobEarlyStoppingType", diff --git a/services/sagemakera2iruntime/pom.xml b/services/sagemakera2iruntime/pom.xml index f27de734fa5b..59b424bfd62a 100644 --- a/services/sagemakera2iruntime/pom.xml +++ b/services/sagemakera2iruntime/pom.xml @@ -21,7 +21,7 @@