{ "version":"2.0", "metadata":{ "apiVersion":"2022-07-26", "auth":["aws.auth#sigv4"], "endpointPrefix":"workspaces-instances", "jsonVersion":"1.0", "protocol":"json", "protocols":["json"], "serviceFullName":"Amazon Workspaces Instances", "serviceId":"Workspaces Instances", "signatureVersion":"v4", "signingName":"workspaces-instances", "targetPrefix":"EUCMIFrontendAPIService", "uid":"workspaces-instances-2022-07-26" }, "operations":{ "AssociateVolume":{ "name":"AssociateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateVolumeRequest"}, "output":{"shape":"AssociateVolumeResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Attaches a volume to a WorkSpace Instance.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{"shape":"CreateVolumeResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"} ], "documentation":"

Creates a new volume for WorkSpace Instances.

", "idempotent":true }, "CreateWorkspaceInstance":{ "name":"CreateWorkspaceInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWorkspaceInstanceRequest"}, "output":{"shape":"CreateWorkspaceInstanceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"} ], "documentation":"

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

", "idempotent":true }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "output":{"shape":"DeleteVolumeResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a specified volume.

" }, "DeleteWorkspaceInstance":{ "name":"DeleteWorkspaceInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWorkspaceInstanceRequest"}, "output":{"shape":"DeleteWorkspaceInstanceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes the specified WorkSpace

" }, "DisassociateVolume":{ "name":"DisassociateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateVolumeRequest"}, "output":{"shape":"DisassociateVolumeResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Detaches a volume from a WorkSpace Instance.

" }, "GetWorkspaceInstance":{ "name":"GetWorkspaceInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWorkspaceInstanceRequest"}, "output":{"shape":"GetWorkspaceInstanceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves detailed information about a specific WorkSpace Instance.

" }, "ListInstanceTypes":{ "name":"ListInstanceTypes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInstanceTypesRequest"}, "output":{"shape":"ListInstanceTypesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

" }, "ListRegions":{ "name":"ListRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRegionsRequest"}, "output":{"shape":"ListRegionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves tags for a WorkSpace Instance.

" }, "ListWorkspaceInstances":{ "name":"ListWorkspaceInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWorkspaceInstancesRequest"}, "output":{"shape":"ListWorkspaceInstancesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves a collection of WorkSpaces Instances based on specified filters.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Adds tags to a WorkSpace Instance.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Removes tags from a WorkSpace Instance.

" } }, "shapes":{ "ARN":{ "type":"string", "max":2048, "min":0, "pattern":"arn:.*" }, "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"

Detailed explanation of the access denial.

" } }, "documentation":"

Indicates insufficient permissions to perform the requested action.

", "exception":true }, "AmdSevSnpEnum":{ "type":"string", "enum":[ "enabled", "disabled" ] }, "AssociateVolumeRequest":{ "type":"structure", "required":[ "WorkspaceInstanceId", "VolumeId", "Device" ], "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

WorkSpace Instance to attach volume to.

" }, "VolumeId":{ "shape":"VolumeId", "documentation":"

Volume to be attached.

" }, "Device":{ "shape":"DeviceName", "documentation":"

Device path for volume attachment.

" } }, "documentation":"

Specifies volume attachment parameters.

" }, "AssociateVolumeResponse":{ "type":"structure", "members":{ }, "documentation":"

Confirms volume attachment.

" }, "AutoRecoveryEnum":{ "type":"string", "enum":[ "disabled", "default" ] }, "AvailabilityZone":{ "type":"string", "pattern":"[a-z]{2}-[a-z]+-\\d[a-z](-[a-z0-9]+)?" }, "BandwidthWeightingEnum":{ "type":"string", "enum":[ "default", "vpc-1", "ebs-1" ] }, "BlockDeviceMappingRequest":{ "type":"structure", "members":{ "DeviceName":{ "shape":"DeviceName", "documentation":"

Name of the device for storage mapping.

" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

EBS volume configuration for the device.

" }, "NoDevice":{ "shape":"DeviceName", "documentation":"

Indicates device should not be mapped.

" }, "VirtualName":{ "shape":"VirtualName", "documentation":"

Virtual device name for ephemeral storage.

" } }, "documentation":"

Defines device mapping for WorkSpace Instance storage.

" }, "BlockDeviceMappings":{ "type":"list", "member":{"shape":"BlockDeviceMappingRequest"} }, "Boolean":{ "type":"boolean", "box":true }, "CapacityReservationPreferenceEnum":{ "type":"string", "enum":[ "capacity-reservations-only", "open", "none" ] }, "CapacityReservationSpecification":{ "type":"structure", "members":{ "CapacityReservationPreference":{ "shape":"CapacityReservationPreferenceEnum", "documentation":"

Preference for using capacity reservation.

" }, "CapacityReservationTarget":{ "shape":"CapacityReservationTarget", "documentation":"

Specific capacity reservation target.

" } }, "documentation":"

Specifies capacity reservation preferences.

" }, "CapacityReservationTarget":{ "type":"structure", "members":{ "CapacityReservationId":{ "shape":"String128", "documentation":"

Unique identifier for the capacity reservation.

" }, "CapacityReservationResourceGroupArn":{ "shape":"ARN", "documentation":"

ARN of the capacity reservation resource group.

" } }, "documentation":"

Identifies a specific capacity reservation.

" }, "ClientToken":{ "type":"string", "max":64, "min":1, "sensitive":true }, "ConflictException":{ "type":"structure", "required":[ "Message", "ResourceId", "ResourceType" ], "members":{ "Message":{ "shape":"String", "documentation":"

Description of the conflict encountered.

" }, "ResourceId":{ "shape":"String", "documentation":"

Identifier of the conflicting resource.

" }, "ResourceType":{ "shape":"String", "documentation":"

Type of the conflicting resource.

" } }, "documentation":"

Signals a conflict with the current state of the resource.

", "exception":true }, "ConnectionTrackingSpecificationRequest":{ "type":"structure", "members":{ "TcpEstablishedTimeout":{ "shape":"NonNegativeInteger", "documentation":"

Timeout for established TCP connections.

" }, "UdpStreamTimeout":{ "shape":"NonNegativeInteger", "documentation":"

Timeout for UDP stream connections.

" }, "UdpTimeout":{ "shape":"NonNegativeInteger", "documentation":"

General timeout for UDP connections.

" } }, "documentation":"

Defines connection tracking parameters for network interfaces.

" }, "CpuCreditsEnum":{ "type":"string", "enum":[ "standard", "unlimited" ] }, "CpuOptionsRequest":{ "type":"structure", "members":{ "AmdSevSnp":{ "shape":"AmdSevSnpEnum", "documentation":"

AMD Secure Encrypted Virtualization configuration.

" }, "CoreCount":{ "shape":"NonNegativeInteger", "documentation":"

Number of CPU cores to allocate.

" }, "ThreadsPerCore":{ "shape":"NonNegativeInteger", "documentation":"

Number of threads per CPU core.

" } }, "documentation":"

Configures CPU-specific settings for WorkSpace Instance.

" }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "AvailabilityZone":{ "shape":"String64", "documentation":"

Availability zone for the volume.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

Unique token to prevent duplicate volume creation.

", "idempotencyToken":true }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates if the volume should be encrypted.

" }, "Iops":{ "shape":"NonNegativeInteger", "documentation":"

Input/output operations per second for the volume.

" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

KMS key for volume encryption.

" }, "SizeInGB":{ "shape":"NonNegativeInteger", "documentation":"

Volume size in gigabytes.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

Source snapshot for volume creation.

" }, "TagSpecifications":{ "shape":"TagSpecifications", "documentation":"

Metadata tags for the volume.

" }, "Throughput":{ "shape":"NonNegativeInteger", "documentation":"

Volume throughput performance.

" }, "VolumeType":{ "shape":"VolumeTypeEnum", "documentation":"

Type of EBS volume.

" } }, "documentation":"

Specifies volume creation parameters.

" }, "CreateVolumeResponse":{ "type":"structure", "members":{ "VolumeId":{ "shape":"VolumeId", "documentation":"

Unique identifier for the new volume.

" } }, "documentation":"

Returns the created volume identifier.

" }, "CreateWorkspaceInstanceRequest":{ "type":"structure", "required":["ManagedInstance"], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"

Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.

", "idempotencyToken":true }, "Tags":{ "shape":"TagList", "documentation":"

Optional metadata tags for categorizing and managing WorkSpaces Instances.

" }, "ManagedInstance":{ "shape":"ManagedInstanceRequest", "documentation":"

Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters.

" } }, "documentation":"

Defines the configuration parameters for creating a new WorkSpaces Instance.

" }, "CreateWorkspaceInstanceResponse":{ "type":"structure", "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier assigned to the newly created WorkSpaces Instance.

" } }, "documentation":"

Returns the unique identifier for the newly created WorkSpaces Instance.

" }, "CreditSpecificationRequest":{ "type":"structure", "members":{ "CpuCredits":{ "shape":"CpuCreditsEnum", "documentation":"

CPU credit specification mode.

" } }, "documentation":"

Defines CPU credit configuration for burstable instances.

" }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"VolumeId", "documentation":"

Identifier of the volume to delete.

" } }, "documentation":"

Specifies the volume to delete.

" }, "DeleteVolumeResponse":{ "type":"structure", "members":{ }, "documentation":"

Confirms volume deletion.

" }, "DeleteWorkspaceInstanceRequest":{ "type":"structure", "required":["WorkspaceInstanceId"], "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier of the WorkSpaces Instance targeted for deletion.

" } }, "documentation":"

The WorkSpace to delete

" }, "DeleteWorkspaceInstanceResponse":{ "type":"structure", "members":{ }, "documentation":"

Confirms the successful deletion of the specified WorkSpace Instance.

" }, "Description":{ "type":"string", "max":1000, "min":0, "pattern":"[\\S\\s]*" }, "DeviceName":{ "type":"string", "max":32, "min":0 }, "DisassociateModeEnum":{ "type":"string", "enum":[ "FORCE", "NO_FORCE" ] }, "DisassociateVolumeRequest":{ "type":"structure", "required":[ "WorkspaceInstanceId", "VolumeId" ], "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

WorkSpace Instance to detach volume from.

" }, "VolumeId":{ "shape":"VolumeId", "documentation":"

Volume to be detached.

" }, "Device":{ "shape":"DeviceName", "documentation":"

Device path of volume to detach.

" }, "DisassociateMode":{ "shape":"DisassociateModeEnum", "documentation":"

Mode for volume detachment.

" } }, "documentation":"

Specifies volume detachment parameters.

" }, "DisassociateVolumeResponse":{ "type":"structure", "members":{ }, "documentation":"

Confirms volume detachment.

" }, "EC2InstanceError":{ "type":"structure", "members":{ "EC2ErrorCode":{ "shape":"String", "documentation":"

Unique error code identifying the specific EC2 instance error.

" }, "EC2ExceptionType":{ "shape":"String", "documentation":"

Type of exception encountered during EC2 instance operation.

" }, "EC2ErrorMessage":{ "shape":"String", "documentation":"

Detailed description of the EC2 instance error.

" } }, "documentation":"

Captures detailed error information for EC2 instance operations.

" }, "EC2InstanceErrors":{ "type":"list", "member":{"shape":"EC2InstanceError"} }, "EC2ManagedInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

Unique identifier of the managed EC2 instance.

" } }, "documentation":"

Represents an EC2 instance managed by WorkSpaces.

" }, "EbsBlockDevice":{ "type":"structure", "members":{ "VolumeType":{ "shape":"VolumeTypeEnum", "documentation":"

Type of EBS volume (e.g., gp2, io1).

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates if the volume is encrypted.

" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

KMS key used for volume encryption.

" }, "Iops":{ "shape":"NonNegativeInteger", "documentation":"

Input/output operations per second for the volume.

" }, "Throughput":{ "shape":"NonNegativeInteger", "documentation":"

Volume data transfer rate.

" }, "VolumeSize":{ "shape":"NonNegativeInteger", "documentation":"

Size of the EBS volume in gigabytes.

" } }, "documentation":"

Defines configuration for an Elastic Block Store volume.

" }, "EnaSrdSpecificationRequest":{ "type":"structure", "members":{ "EnaSrdEnabled":{ "shape":"Boolean", "documentation":"

Enables or disables ENA SRD for network performance.

" }, "EnaSrdUdpSpecification":{ "shape":"EnaSrdUdpSpecificationRequest", "documentation":"

Configures UDP-specific ENA SRD settings.

" } }, "documentation":"

Defines Elastic Network Adapter (ENA) Scalable Reliable Datagram (SRD) configuration.

" }, "EnaSrdUdpSpecificationRequest":{ "type":"structure", "members":{ "EnaSrdUdpEnabled":{ "shape":"Boolean", "documentation":"

Enables or disables ENA SRD for UDP traffic.

" } }, "documentation":"

Specifies UDP configuration for ENA SRD.

" }, "EnclaveOptionsRequest":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Enables or disables AWS Nitro Enclaves for enhanced security.

" } }, "documentation":"

Configures AWS Nitro Enclave options for the WorkSpace Instance.

" }, "GetWorkspaceInstanceRequest":{ "type":"structure", "required":["WorkspaceInstanceId"], "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier of the WorkSpace Instance to retrieve.

" } }, "documentation":"

Identifies the WorkSpaces Instance to retrieve detailed information for.

" }, "GetWorkspaceInstanceResponse":{ "type":"structure", "members":{ "WorkspaceInstanceErrors":{ "shape":"WorkspaceInstanceErrors", "documentation":"

Captures any errors specific to the WorkSpace Instance lifecycle.

" }, "EC2InstanceErrors":{ "shape":"EC2InstanceErrors", "documentation":"

Includes any underlying EC2 instance errors encountered.

" }, "ProvisionState":{ "shape":"ProvisionStateEnum", "documentation":"

Current provisioning state of the WorkSpaces Instance.

" }, "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier of the retrieved WorkSpaces Instance.

" }, "EC2ManagedInstance":{ "shape":"EC2ManagedInstance", "documentation":"

Details of the associated EC2 managed instance.

" } }, "documentation":"

Provides comprehensive details about the requested WorkSpaces Instance.

" }, "HibernationOptionsRequest":{ "type":"structure", "members":{ "Configured":{ "shape":"Boolean", "documentation":"

Enables or disables instance hibernation capability.

" } }, "documentation":"

Defines hibernation configuration for the WorkSpace Instance.

" }, "HostId":{ "type":"string", "pattern":"h-[0-9a-zA-Z]{1,63}" }, "HostnameTypeEnum":{ "type":"string", "enum":[ "ip-name", "resource-name" ] }, "HttpEndpointEnum":{ "type":"string", "enum":[ "enabled", "disabled" ] }, "HttpProtocolIpv6Enum":{ "type":"string", "enum":[ "enabled", "disabled" ] }, "HttpPutResponseHopLimit":{ "type":"integer", "box":true, "max":64, "min":1 }, "HttpTokensEnum":{ "type":"string", "enum":[ "optional", "required" ] }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"

Amazon Resource Name (ARN) of the IAM instance profile.

" }, "Name":{ "shape":"String64", "documentation":"

Name of the IAM instance profile.

" } }, "documentation":"

Defines IAM instance profile configuration for WorkSpace Instance.

" }, "ImageId":{ "type":"string", "pattern":"ami-[0-9a-zA-Z]{1,63}" }, "InstanceInterruptionBehaviorEnum":{ "type":"string", "enum":[ "hibernate", "stop" ] }, "InstanceIpv6Address":{ "type":"structure", "members":{ "Ipv6Address":{ "shape":"Ipv6Address", "documentation":"

Specific IPv6 address assigned to the instance.

" }, "IsPrimaryIpv6":{ "shape":"Boolean", "documentation":"

Indicates if this is the primary IPv6 address for the instance.

" } }, "documentation":"

Represents an IPv6 address configuration for a WorkSpace Instance.

" }, "InstanceMaintenanceOptionsRequest":{ "type":"structure", "members":{ "AutoRecovery":{ "shape":"AutoRecoveryEnum", "documentation":"

Enables or disables automatic instance recovery.

" } }, "documentation":"

Configures automatic maintenance settings for WorkSpace Instance.

" }, "InstanceMarketOptionsRequest":{ "type":"structure", "members":{ "MarketType":{ "shape":"MarketTypeEnum", "documentation":"

Specifies the type of marketplace for instance deployment.

" }, "SpotOptions":{ "shape":"SpotMarketOptions", "documentation":"

Configuration options for spot instance deployment.

" } }, "documentation":"

Configures marketplace-specific instance deployment options.

" }, "InstanceMetadataOptionsRequest":{ "type":"structure", "members":{ "HttpEndpoint":{ "shape":"HttpEndpointEnum", "documentation":"

Enables or disables HTTP endpoint for instance metadata.

" }, "HttpProtocolIpv6":{ "shape":"HttpProtocolIpv6Enum", "documentation":"

Configures IPv6 support for instance metadata HTTP protocol.

" }, "HttpPutResponseHopLimit":{ "shape":"HttpPutResponseHopLimit", "documentation":"

Sets maximum number of network hops for metadata PUT responses.

" }, "HttpTokens":{ "shape":"HttpTokensEnum", "documentation":"

Configures token requirement for instance metadata retrieval.

" }, "InstanceMetadataTags":{ "shape":"InstanceMetadataTagsEnum", "documentation":"

Enables or disables instance metadata tags retrieval.

" } }, "documentation":"

Defines instance metadata service configuration.

" }, "InstanceMetadataTagsEnum":{ "type":"string", "enum":[ "enabled", "disabled" ] }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "AssociateCarrierIpAddress":{ "shape":"Boolean", "documentation":"

Enables carrier IP address association.

" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Enables public IP address assignment.

" }, "ConnectionTrackingSpecification":{ "shape":"ConnectionTrackingSpecificationRequest", "documentation":"

Configures network connection tracking parameters.

" }, "Description":{ "shape":"Description", "documentation":"

Descriptive text for the network interface.

" }, "DeviceIndex":{ "shape":"NonNegativeInteger", "documentation":"

Unique index for the network interface.

" }, "EnaSrdSpecification":{ "shape":"EnaSrdSpecificationRequest", "documentation":"

Configures Elastic Network Adapter Scalable Reliable Datagram settings.

" }, "InterfaceType":{ "shape":"InterfaceTypeEnum", "documentation":"

Specifies the type of network interface.

" }, "Ipv4Prefixes":{ "shape":"Ipv4Prefixes", "documentation":"

IPv4 prefix configurations for the interface.

" }, "Ipv4PrefixCount":{ "shape":"NonNegativeInteger", "documentation":"

Number of IPv4 prefixes to assign.

" }, "Ipv6AddressCount":{ "shape":"NonNegativeInteger", "documentation":"

Number of IPv6 addresses to assign.

" }, "Ipv6Addresses":{ "shape":"Ipv6Addresses", "documentation":"

Specific IPv6 addresses for the interface.

" }, "Ipv6Prefixes":{ "shape":"Ipv6Prefixes", "documentation":"

IPv6 prefix configurations for the interface.

" }, "Ipv6PrefixCount":{ "shape":"NonNegativeInteger", "documentation":"

Number of IPv6 prefixes to assign.

" }, "NetworkCardIndex":{ "shape":"NonNegativeInteger", "documentation":"

Index of the network card for multiple network interfaces.

" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"

Unique identifier for the network interface.

" }, "PrimaryIpv6":{ "shape":"Boolean", "documentation":"

Indicates the primary IPv6 configuration.

" }, "PrivateIpAddress":{ "shape":"Ipv4Address", "documentation":"

Primary private IP address for the interface.

" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddresses", "documentation":"

List of private IP addresses for the interface.

" }, "SecondaryPrivateIpAddressCount":{ "shape":"NonNegativeInteger", "documentation":"

Number of additional private IP addresses to assign.

" }, "Groups":{ "shape":"SecurityGroupIds", "documentation":"

Security groups associated with the network interface.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

Subnet identifier for the network interface.

" } }, "documentation":"

Defines network interface configuration for WorkSpace Instance.

" }, "InstanceNetworkPerformanceOptionsRequest":{ "type":"structure", "members":{ "BandwidthWeighting":{ "shape":"BandwidthWeightingEnum", "documentation":"

Defines bandwidth allocation strategy for network interfaces.

" } }, "documentation":"

Configures network performance settings for WorkSpace Instance.

" }, "InstanceType":{ "type":"string", "pattern":"([a-z0-9-]+)\\.([a-z0-9]+)" }, "InstanceTypeInfo":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

Unique identifier for the WorkSpace Instance type.

" } }, "documentation":"

Provides details about a specific WorkSpace Instance type.

" }, "InstanceTypes":{ "type":"list", "member":{"shape":"InstanceTypeInfo"} }, "Integer":{ "type":"integer", "box":true }, "InterfaceTypeEnum":{ "type":"string", "enum":[ "interface", "efa", "efa-only" ] }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"

Description of the internal server error.

" }, "RetryAfterSeconds":{ "shape":"Integer", "documentation":"

Recommended wait time before retrying the request.

" } }, "documentation":"

Indicates an unexpected server-side error occurred.

", "exception":true, "fault":true, "retryable":{"throttling":false} }, "Ipv4Address":{ "type":"string", "pattern":"(\\b25[0-5]|\\b2[0-4][0-9]|\\b[01]?[0-9][0-9]?)(\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}", "sensitive":true }, "Ipv4Prefix":{ "type":"string", "pattern":".*(?:(?:\\d|[01]?\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d|\\d)(?:/\\d{1,2})?.*" }, "Ipv4PrefixSpecificationRequest":{ "type":"structure", "members":{ "Ipv4Prefix":{ "shape":"Ipv4Prefix", "documentation":"

Specific IPv4 prefix for network interface configuration.

" } }, "documentation":"

Specifies IPv4 prefix configuration for network interfaces.

" }, "Ipv4Prefixes":{ "type":"list", "member":{"shape":"Ipv4PrefixSpecificationRequest"} }, "Ipv6Address":{ "type":"string", "max":128, "min":0, "sensitive":true }, "Ipv6Addresses":{ "type":"list", "member":{"shape":"InstanceIpv6Address"} }, "Ipv6Prefix":{ "type":"string", "pattern":"(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\\/([0-9]{1,2}|1[01][0-9]|12[0-8])" }, "Ipv6PrefixSpecificationRequest":{ "type":"structure", "members":{ "Ipv6Prefix":{ "shape":"Ipv6Prefix", "documentation":"

Specific IPv6 prefix for network interface configuration.

" } }, "documentation":"

Specifies IPv6 prefix configuration for network interfaces.

" }, "Ipv6Prefixes":{ "type":"list", "member":{"shape":"Ipv6PrefixSpecificationRequest"} }, "KmsKeyId":{ "type":"string", "max":128, "min":0, "sensitive":true }, "LicenseConfigurationRequest":{ "type":"structure", "members":{ "LicenseConfigurationArn":{ "shape":"ARN", "documentation":"

ARN of the license configuration for the WorkSpace Instance.

" } }, "documentation":"

Specifies license configuration for WorkSpace Instance.

" }, "LicenseSpecifications":{ "type":"list", "member":{"shape":"LicenseConfigurationRequest"} }, "ListInstanceTypesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of instance types to return in a single API call. Enables pagination of instance type results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Pagination token for retrieving subsequent pages of instance type results.

" } }, "documentation":"

Defines input parameters for retrieving supported WorkSpaces Instances instance types.

" }, "ListInstanceTypesResponse":{ "type":"structure", "required":["InstanceTypes"], "members":{ "InstanceTypes":{ "shape":"InstanceTypes", "documentation":"

Collection of supported instance types for WorkSpaces Instances.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for retrieving additional instance types if the result set is paginated.

" } }, "documentation":"

Contains the list of instance types supported by WorkSpaces Instances.

" }, "ListRegionsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of regions to return in a single API call. Enables pagination of region results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Pagination token for retrieving subsequent pages of region results.

" } }, "documentation":"

Defines input parameters for retrieving supported WorkSpaces Instances regions.

" }, "ListRegionsResponse":{ "type":"structure", "required":["Regions"], "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Collection of AWS regions supported by WorkSpaces Instances.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for retrieving additional regions if the result set is paginated.

" } }, "documentation":"

Contains the list of supported AWS regions for WorkSpaces Instances.

" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["WorkspaceInstanceId"], "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier of the WorkSpace Instance.

" } }, "documentation":"

Specifies the WorkSpace Instance to retrieve tags for.

" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

Collection of tags associated with the WorkSpace Instance.

" } }, "documentation":"

Returns the list of tags for the specified WorkSpace Instance.

" }, "ListWorkspaceInstancesRequest":{ "type":"structure", "members":{ "ProvisionStates":{ "shape":"ProvisionStates", "documentation":"

Filter WorkSpaces Instances by their current provisioning states.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of WorkSpaces Instances to return in a single response.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Pagination token for retrieving subsequent pages of WorkSpaces Instances.

" } }, "documentation":"

Defines filters and pagination parameters for retrieving WorkSpaces Instances.

" }, "ListWorkspaceInstancesResponse":{ "type":"structure", "required":["WorkspaceInstances"], "members":{ "WorkspaceInstances":{ "shape":"WorkspaceInstances", "documentation":"

Collection of WorkSpaces Instances returned by the query.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for retrieving additional WorkSpaces Instances if the result set is paginated.

" } }, "documentation":"

Contains the list of WorkSpaces Instances matching the specified criteria.

" }, "ManagedInstanceRequest":{ "type":"structure", "members":{ "BlockDeviceMappings":{ "shape":"BlockDeviceMappings", "documentation":"

Configures block device mappings for storage.

" }, "CapacityReservationSpecification":{ "shape":"CapacityReservationSpecification", "documentation":"

Specifies capacity reservation preferences.

" }, "CpuOptions":{ "shape":"CpuOptionsRequest", "documentation":"

Configures CPU-specific settings.

" }, "CreditSpecification":{ "shape":"CreditSpecificationRequest", "documentation":"

Defines CPU credit configuration for burstable instances.

" }, "DisableApiStop":{ "shape":"Boolean", "documentation":"

Prevents API-initiated instance stop.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Enables optimized EBS performance.

" }, "EnablePrimaryIpv6":{ "shape":"Boolean", "documentation":"

Enables primary IPv6 address configuration.

" }, "EnclaveOptions":{ "shape":"EnclaveOptionsRequest", "documentation":"

Configures AWS Nitro Enclave settings.

" }, "HibernationOptions":{ "shape":"HibernationOptionsRequest", "documentation":"

Configures instance hibernation capabilities.

" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

Specifies IAM instance profile configuration.

" }, "ImageId":{ "shape":"ImageId", "documentation":"

Identifies the Amazon Machine Image (AMI) for the instance.

" }, "InstanceMarketOptions":{ "shape":"InstanceMarketOptionsRequest", "documentation":"

Configures marketplace-specific deployment options.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

Specifies the WorkSpace Instance type.

" }, "Ipv6Addresses":{ "shape":"Ipv6Addresses", "documentation":"

Configures specific IPv6 addresses.

" }, "Ipv6AddressCount":{ "shape":"NonNegativeInteger", "documentation":"

Specifies number of IPv6 addresses to assign.

" }, "KernelId":{ "shape":"String128", "documentation":"

Identifies the kernel for the instance.

" }, "KeyName":{ "shape":"String64", "documentation":"

Specifies the key pair for instance access.

" }, "LicenseSpecifications":{ "shape":"LicenseSpecifications", "documentation":"

Configures license-related settings.

" }, "MaintenanceOptions":{ "shape":"InstanceMaintenanceOptionsRequest", "documentation":"

Defines automatic maintenance settings.

" }, "MetadataOptions":{ "shape":"InstanceMetadataOptionsRequest", "documentation":"

Configures instance metadata service settings.

" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

Enables or disables detailed instance monitoring.

" }, "NetworkInterfaces":{ "shape":"NetworkInterfaces", "documentation":"

Configures network interface settings.

" }, "NetworkPerformanceOptions":{ "shape":"InstanceNetworkPerformanceOptionsRequest", "documentation":"

Defines network performance configuration.

" }, "Placement":{ "shape":"Placement", "documentation":"

Specifies instance placement preferences.

" }, "PrivateDnsNameOptions":{ "shape":"PrivateDnsNameOptionsRequest", "documentation":"

Configures private DNS name settings.

" }, "PrivateIpAddress":{ "shape":"Ipv4Address", "documentation":"

Specifies the primary private IP address.

" }, "RamdiskId":{ "shape":"String128", "documentation":"

Identifies the ramdisk for the instance.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

Specifies security group identifiers.

" }, "SecurityGroups":{ "shape":"SecurityGroupNames", "documentation":"

Configures security group settings.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

Identifies the subnet for the instance.

" }, "TagSpecifications":{ "shape":"TagSpecifications", "documentation":"

Configures resource tagging specifications.

" }, "UserData":{ "shape":"UserData", "documentation":"

Provides custom initialization data for the instance.

" } }, "documentation":"

Defines comprehensive configuration for a managed WorkSpace Instance.

" }, "MarketTypeEnum":{ "type":"string", "enum":[ "spot", "capacity-block" ] }, "MaxResults":{ "type":"integer", "box":true, "max":25, "min":1 }, "NetworkInterfaceId":{ "type":"string", "pattern":"eni-[0-9a-zA-Z]{1,63}" }, "NetworkInterfaces":{ "type":"list", "member":{"shape":"InstanceNetworkInterfaceSpecification"} }, "NextToken":{ "type":"string", "max":2048, "min":1, "sensitive":true }, "NonNegativeInteger":{ "type":"integer", "box":true, "min":0 }, "Placement":{ "type":"structure", "members":{ "Affinity":{ "shape":"String64", "documentation":"

Specifies host affinity for dedicated instances.

" }, "AvailabilityZone":{ "shape":"AvailabilityZone", "documentation":"

Identifies the specific AWS availability zone.

" }, "GroupId":{ "shape":"PlacementGroupId", "documentation":"

Unique identifier for placement group.

" }, "GroupName":{ "shape":"String64", "documentation":"

Name of the placement group.

" }, "HostId":{ "shape":"HostId", "documentation":"

Identifies the specific dedicated host.

" }, "HostResourceGroupArn":{ "shape":"ARN", "documentation":"

ARN of the host resource group.

" }, "PartitionNumber":{ "shape":"NonNegativeInteger", "documentation":"

Specifies partition number for partition placement groups.

" }, "Tenancy":{ "shape":"TenancyEnum", "documentation":"

Defines instance tenancy configuration.

" } }, "documentation":"

Defines instance placement configuration for WorkSpace Instance.

" }, "PlacementGroupId":{ "type":"string", "pattern":"pg-[0-9a-zA-Z]{1,63}" }, "PrivateDnsNameOptionsRequest":{ "type":"structure", "members":{ "HostnameType":{ "shape":"HostnameTypeEnum", "documentation":"

Specifies the type of hostname configuration.

" }, "EnableResourceNameDnsARecord":{ "shape":"Boolean", "documentation":"

Enables DNS A record for resource name resolution.

" }, "EnableResourceNameDnsAAAARecord":{ "shape":"Boolean", "documentation":"

Enables DNS AAAA record for resource name resolution.

" } }, "documentation":"

Configures private DNS name settings for WorkSpace Instance.

" }, "PrivateIpAddressSpecification":{ "type":"structure", "members":{ "Primary":{ "shape":"Boolean", "documentation":"

Indicates if this is the primary private IP address.

" }, "PrivateIpAddress":{ "shape":"Ipv4Address", "documentation":"

Specific private IP address for the network interface.

" } }, "documentation":"

Defines private IP address configuration for network interface.

" }, "PrivateIpAddresses":{ "type":"list", "member":{"shape":"PrivateIpAddressSpecification"} }, "ProvisionStateEnum":{ "type":"string", "enum":[ "ALLOCATING", "ALLOCATED", "DEALLOCATING", "DEALLOCATED", "ERROR_ALLOCATING", "ERROR_DEALLOCATING" ] }, "ProvisionStates":{ "type":"list", "member":{"shape":"ProvisionStateEnum"} }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"RegionName", "documentation":"

Name of the AWS region.

" } }, "documentation":"

Represents an AWS region supported by WorkSpaces Instances.

" }, "RegionList":{ "type":"list", "member":{"shape":"Region"} }, "RegionName":{ "type":"string", "pattern":"[-0-9a-z]{1,31}" }, "ResourceNotFoundException":{ "type":"structure", "required":[ "Message", "ResourceId", "ResourceType" ], "members":{ "Message":{ "shape":"String", "documentation":"

Details about the missing resource.

" }, "ResourceId":{ "shape":"String", "documentation":"

Identifier of the resource that was not found.

" }, "ResourceType":{ "shape":"String", "documentation":"

Type of the resource that was not found.

" } }, "documentation":"

Indicates the requested resource could not be found.

", "exception":true }, "ResourceTypeEnum":{ "type":"string", "enum":[ "instance", "volume", "spot-instances-request", "network-interface" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Enables or disables detailed instance monitoring.

" } }, "documentation":"

Configures detailed monitoring for WorkSpace Instance.

" }, "SecurityGroupId":{ "type":"string", "pattern":"sg-[0-9a-zA-Z]{1,63}" }, "SecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"} }, "SecurityGroupName":{ "type":"string", "pattern":"(?!sg-)[\\w .:/()#,@\\[\\]+=&;{}!$*-]{0,255}" }, "SecurityGroupNames":{ "type":"list", "member":{"shape":"SecurityGroupName"} }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "Message", "ResourceId", "ResourceType", "ServiceCode", "QuotaCode" ], "members":{ "Message":{ "shape":"String", "documentation":"

Description of the quota limitation.

" }, "ResourceId":{ "shape":"String", "documentation":"

Identifier of the resource related to the quota.

" }, "ResourceType":{ "shape":"String", "documentation":"

Type of resource related to the quota.

" }, "ServiceCode":{ "shape":"String", "documentation":"

Code identifying the service with the quota limitation.

" }, "QuotaCode":{ "shape":"String", "documentation":"

Specific code for the exceeded quota.

" } }, "documentation":"

Indicates that a service quota has been exceeded.

", "exception":true }, "SnapshotId":{ "type":"string", "pattern":"snap-[0-9a-zA-Z]{1,63}" }, "SpotInstanceTypeEnum":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotMarketOptions":{ "type":"structure", "members":{ "BlockDurationMinutes":{ "shape":"NonNegativeInteger", "documentation":"

Duration of spot instance block reservation.

" }, "InstanceInterruptionBehavior":{ "shape":"InstanceInterruptionBehaviorEnum", "documentation":"

Specifies behavior when spot instance is interrupted.

" }, "MaxPrice":{ "shape":"String64", "documentation":"

Maximum hourly price for spot instance.

" }, "SpotInstanceType":{ "shape":"SpotInstanceTypeEnum", "documentation":"

Defines the type of spot instance request.

" }, "ValidUntilUtc":{ "shape":"Timestamp", "documentation":"

Timestamp until which spot instance request is valid.

" } }, "documentation":"

Defines configuration for spot instance deployment.

" }, "String":{"type":"string"}, "String128":{ "type":"string", "max":128, "min":0 }, "String64":{ "type":"string", "max":64, "min":0 }, "SubnetId":{ "type":"string", "pattern":"subnet-[0-9a-zA-Z]{1,63}" }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

Unique identifier for the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

Value associated with the tag key.

" } }, "documentation":"

Represents a key-value metadata tag.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":30, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":30, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "WorkspaceInstanceId", "Tags" ], "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier of the WorkSpace Instance to tag.

" }, "Tags":{ "shape":"TagList", "documentation":"

Tags to be added to the WorkSpace Instance.

" } }, "documentation":"

Specifies tags to add to a WorkSpace Instance.

" }, "TagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

Confirms successful tag addition.

" }, "TagSpecification":{ "type":"structure", "members":{ "ResourceType":{ "shape":"ResourceTypeEnum", "documentation":"

Type of resource being tagged.

" }, "Tags":{ "shape":"TagList", "documentation":"

Collection of tags for the specified resource.

" } }, "documentation":"

Defines tagging configuration for a resource.

" }, "TagSpecifications":{ "type":"list", "member":{"shape":"TagSpecification"}, "max":30, "min":0 }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TenancyEnum":{ "type":"string", "enum":[ "default", "dedicated", "host" ] }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"

Description of the throttling event.

" }, "ServiceCode":{ "shape":"String", "documentation":"

Code identifying the service experiencing throttling.

" }, "QuotaCode":{ "shape":"String", "documentation":"

Specific code for the throttling quota.

" }, "RetryAfterSeconds":{ "shape":"Integer", "documentation":"

Recommended wait time before retrying the request.

" } }, "documentation":"

Indicates the request rate has exceeded limits.

", "exception":true, "retryable":{"throttling":true} }, "Timestamp":{"type":"timestamp"}, "UntagResourceRequest":{ "type":"structure", "required":[ "WorkspaceInstanceId", "TagKeys" ], "members":{ "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier of the WorkSpace Instance to untag.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

Keys of tags to be removed.

" } }, "documentation":"

Specifies tags to remove from a WorkSpace Instance.

" }, "UntagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

Confirms successful tag removal.

" }, "UserData":{ "type":"string", "max":16000, "min":0, "sensitive":true }, "ValidationException":{ "type":"structure", "required":[ "Message", "Reason" ], "members":{ "Message":{ "shape":"String", "documentation":"

Overall description of validation failures.

" }, "Reason":{ "shape":"ValidationExceptionReason", "documentation":"

Specific reason for the validation failure.

" }, "FieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"

List of fields that failed validation.

" } }, "documentation":"

Indicates invalid input parameters in the request.

", "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "Reason", "Message" ], "members":{ "Name":{ "shape":"String", "documentation":"

Name of the field that failed validation.

" }, "Reason":{ "shape":"String", "documentation":"

Reason for the validation failure.

" }, "Message":{ "shape":"String", "documentation":"

Detailed error message describing the validation issue.

" } }, "documentation":"

Represents a validation error field in an API request.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "UNKNOWN_OPERATION", "UNSUPPORTED_OPERATION", "CANNOT_PARSE", "FIELD_VALIDATION_FAILED", "DEPENDENCY_FAILURE", "OTHER" ] }, "VirtualName":{ "type":"string", "pattern":"ephemeral(0|[1-9][0-9]{0,2})" }, "VolumeId":{ "type":"string", "pattern":"vol-[0-9a-zA-Z]{1,63}" }, "VolumeTypeEnum":{ "type":"string", "enum":[ "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3" ] }, "WorkspaceInstance":{ "type":"structure", "members":{ "ProvisionState":{ "shape":"ProvisionStateEnum", "documentation":"

Current provisioning state of the WorkSpace Instance.

" }, "WorkspaceInstanceId":{ "shape":"WorkspaceInstanceId", "documentation":"

Unique identifier for the WorkSpace Instance.

" }, "EC2ManagedInstance":{ "shape":"EC2ManagedInstance", "documentation":"

Details of the associated EC2 managed instance.

" } }, "documentation":"

Represents a single WorkSpace Instance.

" }, "WorkspaceInstanceError":{ "type":"structure", "members":{ "ErrorCode":{ "shape":"String", "documentation":"

Unique error code for the WorkSpace Instance error.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

Detailed description of the WorkSpace Instance error.

" } }, "documentation":"

Captures errors specific to WorkSpace Instance operations.

" }, "WorkspaceInstanceErrors":{ "type":"list", "member":{"shape":"WorkspaceInstanceError"} }, "WorkspaceInstanceId":{ "type":"string", "max":70, "min":15, "pattern":"wsinst-[0-9a-zA-Z]{8,63}" }, "WorkspaceInstances":{ "type":"list", "member":{"shape":"WorkspaceInstance"} } }, "documentation":"

Amazon WorkSpaces Instances provides an API framework for managing virtual workspace environments across multiple AWS regions, enabling programmatic creation and configuration of desktop infrastructure.

" }