{ "smithy": "2.0", "shapes": { "com.amazonaws.workspacesinstances#ARN": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^arn:.*" } }, "com.amazonaws.workspacesinstances#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "
Detailed explanation of the access denial.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Indicates insufficient permissions to perform the requested action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.workspacesinstances#AmdSevSnpEnum": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.workspacesinstances#AssociateVolume": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#AssociateVolumeRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#AssociateVolumeResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#ConflictException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to associate a workspace managed volume to a workspace managed instance in your account" }, "smithy.api#documentation": "Attaches a volume to a WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#AssociateVolumeRequest": { "type": "structure", "members": { "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "WorkSpace Instance to attach volume to.
", "smithy.api#required": {} } }, "VolumeId": { "target": "com.amazonaws.workspacesinstances#VolumeId", "traits": { "smithy.api#documentation": "Volume to be attached.
", "smithy.api#required": {} } }, "Device": { "target": "com.amazonaws.workspacesinstances#DeviceName", "traits": { "smithy.api#documentation": "Device path for volume attachment.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies volume attachment parameters.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#AssociateVolumeResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Confirms volume attachment.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#AutoRecoveryEnum": { "type": "enum", "members": { "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } }, "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "default" } } } }, "com.amazonaws.workspacesinstances#AvailabilityZone": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z]{2}-[a-z]+-\\d(?:[a-z]|-[a-z]+-\\d[a-z])$" } }, "com.amazonaws.workspacesinstances#BandwidthWeightingEnum": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "default" } }, "VPC_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "vpc-1" } }, "EBS_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ebs-1" } } } }, "com.amazonaws.workspacesinstances#BillingConfiguration": { "type": "structure", "members": { "BillingMode": { "target": "com.amazonaws.workspacesinstances#BillingMode", "traits": { "smithy.api#documentation": "Specifies the billing mode for WorkSpace Instances. MONTHLY provides fixed monthly rates for predictable budgeting, while HOURLY enables pay-per-second billing for actual usage.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Defines billing configuration settings for WorkSpace Instances, containing the billing mode selection.
" } }, "com.amazonaws.workspacesinstances#BillingMode": { "type": "enum", "members": { "MONTHLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MONTHLY" } }, "HOURLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOURLY" } } } }, "com.amazonaws.workspacesinstances#BlockDeviceMappingRequest": { "type": "structure", "members": { "DeviceName": { "target": "com.amazonaws.workspacesinstances#DeviceName", "traits": { "smithy.api#documentation": "Name of the device for storage mapping.
" } }, "Ebs": { "target": "com.amazonaws.workspacesinstances#EbsBlockDevice", "traits": { "smithy.api#documentation": "EBS volume configuration for the device.
" } }, "NoDevice": { "target": "com.amazonaws.workspacesinstances#DeviceName", "traits": { "smithy.api#documentation": "Indicates device should not be mapped.
" } }, "VirtualName": { "target": "com.amazonaws.workspacesinstances#VirtualName", "traits": { "smithy.api#documentation": "Virtual device name for ephemeral storage.
" } } }, "traits": { "smithy.api#documentation": "Defines device mapping for WorkSpace Instance storage.
" } }, "com.amazonaws.workspacesinstances#BlockDeviceMappings": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#BlockDeviceMappingRequest" } }, "com.amazonaws.workspacesinstances#CapacityReservationPreferenceEnum": { "type": "enum", "members": { "CAPACITY_RESERVATIONS_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "capacity-reservations-only" } }, "OPEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "open" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "none" } } } }, "com.amazonaws.workspacesinstances#CapacityReservationSpecification": { "type": "structure", "members": { "CapacityReservationPreference": { "target": "com.amazonaws.workspacesinstances#CapacityReservationPreferenceEnum", "traits": { "smithy.api#documentation": "Preference for using capacity reservation.
" } }, "CapacityReservationTarget": { "target": "com.amazonaws.workspacesinstances#CapacityReservationTarget", "traits": { "smithy.api#documentation": "Specific capacity reservation target.
" } } }, "traits": { "smithy.api#documentation": "Specifies capacity reservation preferences.
" } }, "com.amazonaws.workspacesinstances#CapacityReservationTarget": { "type": "structure", "members": { "CapacityReservationId": { "target": "com.amazonaws.workspacesinstances#String128", "traits": { "smithy.api#documentation": "Unique identifier for the capacity reservation.
" } }, "CapacityReservationResourceGroupArn": { "target": "com.amazonaws.workspacesinstances#ARN", "traits": { "smithy.api#documentation": "ARN of the capacity reservation resource group.
" } } }, "traits": { "smithy.api#documentation": "Identifies a specific capacity reservation.
" } }, "com.amazonaws.workspacesinstances#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\x20-\\x7E]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesinstances#ConflictException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Description of the conflict encountered.
", "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Identifier of the conflicting resource.
", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Type of the conflicting resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Signals a conflict with the current state of the resource.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.workspacesinstances#ConnectionTrackingSpecificationRequest": { "type": "structure", "members": { "TcpEstablishedTimeout": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Timeout for established TCP connections.
" } }, "UdpStreamTimeout": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Timeout for UDP stream connections.
" } }, "UdpTimeout": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "General timeout for UDP connections.
" } } }, "traits": { "smithy.api#documentation": "Defines connection tracking parameters for network interfaces.
" } }, "com.amazonaws.workspacesinstances#CpuCreditsEnum": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "standard" } }, "UNLIMITED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unlimited" } } } }, "com.amazonaws.workspacesinstances#CpuOptionsRequest": { "type": "structure", "members": { "AmdSevSnp": { "target": "com.amazonaws.workspacesinstances#AmdSevSnpEnum", "traits": { "smithy.api#documentation": "AMD Secure Encrypted Virtualization configuration.
" } }, "CoreCount": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Number of CPU cores to allocate.
" } }, "ThreadsPerCore": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Number of threads per CPU core.
" } }, "NestedVirtualization": { "target": "com.amazonaws.workspacesinstances#NestedVirtualizationEnum", "traits": { "smithy.api#documentation": "Specifies whether to enable or disable nested virtualization.
" } } }, "traits": { "smithy.api#documentation": "Configures CPU-specific settings for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#CreateVolume": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#CreateVolumeRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#CreateVolumeResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#ConflictException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ServiceQuotaExceededException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a workspace managed volume in your account" }, "smithy.api#documentation": "Creates a new volume for WorkSpace Instances.
", "smithy.api#idempotent": {} } }, "com.amazonaws.workspacesinstances#CreateVolumeRequest": { "type": "structure", "members": { "AvailabilityZone": { "target": "com.amazonaws.workspacesinstances#String64", "traits": { "smithy.api#documentation": "Availability zone for the volume.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.workspacesinstances#ClientToken", "traits": { "smithy.api#documentation": "Unique token to prevent duplicate volume creation.
", "smithy.api#idempotencyToken": {} } }, "Encrypted": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates if the volume should be encrypted.
" } }, "Iops": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Input/output operations per second for the volume.
" } }, "KmsKeyId": { "target": "com.amazonaws.workspacesinstances#KmsKeyId", "traits": { "smithy.api#documentation": "KMS key for volume encryption.
" } }, "SizeInGB": { "target": "com.amazonaws.workspacesinstances#VolumeSizeInGB", "traits": { "smithy.api#documentation": "Volume size in gigabytes.
" } }, "SnapshotId": { "target": "com.amazonaws.workspacesinstances#SnapshotId", "traits": { "smithy.api#documentation": "Source snapshot for volume creation.
" } }, "TagSpecifications": { "target": "com.amazonaws.workspacesinstances#TagSpecifications", "traits": { "smithy.api#documentation": "Metadata tags for the volume.
" } }, "Throughput": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Volume throughput performance.
" } }, "VolumeType": { "target": "com.amazonaws.workspacesinstances#VolumeTypeEnum", "traits": { "smithy.api#documentation": "Type of EBS volume.
" } } }, "traits": { "smithy.api#documentation": "Specifies volume creation parameters.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#CreateVolumeResponse": { "type": "structure", "members": { "VolumeId": { "target": "com.amazonaws.workspacesinstances#VolumeId", "traits": { "smithy.api#documentation": "Unique identifier for the new volume.
" } } }, "traits": { "smithy.api#documentation": "Returns the created volume identifier.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#CreateWorkspaceInstance": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#CreateWorkspaceInstanceRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#CreateWorkspaceInstanceResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#ConflictException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ServiceQuotaExceededException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a workspace managed instance in your account" }, "smithy.api#documentation": "Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.
", "smithy.api#idempotent": {} } }, "com.amazonaws.workspacesinstances#CreateWorkspaceInstanceRequest": { "type": "structure", "members": { "ClientToken": { "target": "com.amazonaws.workspacesinstances#ClientToken", "traits": { "smithy.api#documentation": "Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.
", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.workspacesinstances#TagList", "traits": { "smithy.api#documentation": "Optional metadata tags for categorizing and managing WorkSpaces Instances.
" } }, "ManagedInstance": { "target": "com.amazonaws.workspacesinstances#ManagedInstanceRequest", "traits": { "smithy.api#documentation": "Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters.
", "smithy.api#required": {} } }, "BillingConfiguration": { "target": "com.amazonaws.workspacesinstances#BillingConfiguration", "traits": { "smithy.api#documentation": "Optional billing configuration for the WorkSpace Instance. Allows customers to specify their preferred billing mode when creating a new instance. Defaults to hourly billing if not specified.
" } } }, "traits": { "smithy.api#documentation": "Defines the configuration parameters for creating a new WorkSpaces Instance.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#CreateWorkspaceInstanceResponse": { "type": "structure", "members": { "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "Unique identifier assigned to the newly created WorkSpaces Instance.
" } } }, "traits": { "smithy.api#documentation": "Returns the unique identifier for the newly created WorkSpaces Instance.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#CreditSpecificationRequest": { "type": "structure", "members": { "CpuCredits": { "target": "com.amazonaws.workspacesinstances#CpuCreditsEnum", "traits": { "smithy.api#documentation": "CPU credit specification mode.
" } } }, "traits": { "smithy.api#documentation": "Defines CPU credit configuration for burstable instances.
" } }, "com.amazonaws.workspacesinstances#DeleteVolume": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#DeleteVolumeRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#DeleteVolumeResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#ConflictException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a workspace managed volume in your account" }, "smithy.api#documentation": "Deletes a specified volume.
" } }, "com.amazonaws.workspacesinstances#DeleteVolumeRequest": { "type": "structure", "members": { "VolumeId": { "target": "com.amazonaws.workspacesinstances#VolumeId", "traits": { "smithy.api#documentation": "Identifier of the volume to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the volume to delete.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#DeleteVolumeResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Confirms volume deletion.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#DeleteWorkspaceInstance": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#DeleteWorkspaceInstanceRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#DeleteWorkspaceInstanceResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#ConflictException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a workspace managed instance in your account" }, "smithy.api#documentation": "Deletes the specified WorkSpace
Usage of this API will result in deletion of the resource in question.
Unique identifier of the WorkSpaces Instance targeted for deletion.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The WorkSpace to delete
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#DeleteWorkspaceInstanceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Confirms the successful deletion of the specified WorkSpace Instance.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#Description": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.workspacesinstances#DeviceName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32 } } }, "com.amazonaws.workspacesinstances#DisassociateModeEnum": { "type": "enum", "members": { "FORCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FORCE" } }, "NO_FORCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_FORCE" } } } }, "com.amazonaws.workspacesinstances#DisassociateVolume": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#DisassociateVolumeRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#DisassociateVolumeResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#ConflictException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to disassociate a workspace managed volume from a workspace managed instance in your account" }, "smithy.api#documentation": "Detaches a volume from a WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#DisassociateVolumeRequest": { "type": "structure", "members": { "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "WorkSpace Instance to detach volume from.
", "smithy.api#required": {} } }, "VolumeId": { "target": "com.amazonaws.workspacesinstances#VolumeId", "traits": { "smithy.api#documentation": "Volume to be detached.
", "smithy.api#required": {} } }, "Device": { "target": "com.amazonaws.workspacesinstances#DeviceName", "traits": { "smithy.api#documentation": "Device path of volume to detach.
" } }, "DisassociateMode": { "target": "com.amazonaws.workspacesinstances#DisassociateModeEnum", "traits": { "smithy.api#documentation": "Mode for volume detachment.
" } } }, "traits": { "smithy.api#documentation": "Specifies volume detachment parameters.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#DisassociateVolumeResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Confirms volume detachment.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#EC2InstanceError": { "type": "structure", "members": { "EC2ErrorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Unique error code identifying the specific EC2 instance error.
" } }, "EC2ExceptionType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Type of exception encountered during EC2 instance operation.
" } }, "EC2ErrorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Detailed description of the EC2 instance error.
" } } }, "traits": { "smithy.api#documentation": "Captures detailed error information for EC2 instance operations.
" } }, "com.amazonaws.workspacesinstances#EC2InstanceErrors": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#EC2InstanceError" } }, "com.amazonaws.workspacesinstances#EC2ManagedInstance": { "type": "structure", "members": { "InstanceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Unique identifier of the managed EC2 instance.
" } } }, "traits": { "smithy.api#documentation": "Represents an EC2 instance managed by WorkSpaces.
" } }, "com.amazonaws.workspacesinstances#EUCMIFrontendAPIService": { "type": "service", "version": "2022-07-26", "operations": [ { "target": "com.amazonaws.workspacesinstances#AssociateVolume" }, { "target": "com.amazonaws.workspacesinstances#CreateVolume" }, { "target": "com.amazonaws.workspacesinstances#CreateWorkspaceInstance" }, { "target": "com.amazonaws.workspacesinstances#DeleteVolume" }, { "target": "com.amazonaws.workspacesinstances#DeleteWorkspaceInstance" }, { "target": "com.amazonaws.workspacesinstances#DisassociateVolume" }, { "target": "com.amazonaws.workspacesinstances#GetWorkspaceInstance" }, { "target": "com.amazonaws.workspacesinstances#ListInstanceTypes" }, { "target": "com.amazonaws.workspacesinstances#ListRegions" }, { "target": "com.amazonaws.workspacesinstances#ListTagsForResource" }, { "target": "com.amazonaws.workspacesinstances#ListWorkspaceInstances" }, { "target": "com.amazonaws.workspacesinstances#ModifyVolume" }, { "target": "com.amazonaws.workspacesinstances#TagResource" }, { "target": "com.amazonaws.workspacesinstances#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "Workspaces Instances", "arnNamespace": "workspaces-instances", "cloudFormationName": "WorkspacesInstances", "cloudTrailEventSource": "workspaces-instances.amazonaws.com" }, "aws.auth#sigv4": { "name": "workspaces-instances" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#defineConditionKeys": { "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access based on the tags associated with the resource", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access based on the tags that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access based on the tag keys that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#awsJson1_0": {}, "smithy.api#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.
", "smithy.api#title": "Amazon Workspaces Instances", "smithy.protocols#rpcv2Cbor": {}, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://workspaces-instances-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://workspaces-instances.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://workspaces-instances-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://workspaces-instances.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://workspaces-instances-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://workspaces-instances.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://workspaces-instances-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://workspaces-instances.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://workspaces-instances-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://workspaces-instances.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.workspacesinstances#EbsBlockDevice": { "type": "structure", "members": { "VolumeType": { "target": "com.amazonaws.workspacesinstances#VolumeTypeEnum", "traits": { "smithy.api#documentation": "Type of EBS volume (e.g., gp2, io1).
" } }, "Encrypted": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates if the volume is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.workspacesinstances#KmsKeyId", "traits": { "smithy.api#documentation": "KMS key used for volume encryption.
" } }, "Iops": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Input/output operations per second for the volume.
" } }, "Throughput": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Volume data transfer rate.
" } }, "VolumeSize": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Size of the EBS volume in gigabytes.
" } } }, "traits": { "smithy.api#documentation": "Defines configuration for an Elastic Block Store volume.
" } }, "com.amazonaws.workspacesinstances#EnaSrdSpecificationRequest": { "type": "structure", "members": { "EnaSrdEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables or disables ENA SRD for network performance.
" } }, "EnaSrdUdpSpecification": { "target": "com.amazonaws.workspacesinstances#EnaSrdUdpSpecificationRequest", "traits": { "smithy.api#documentation": "Configures UDP-specific ENA SRD settings.
" } } }, "traits": { "smithy.api#documentation": "Defines Elastic Network Adapter (ENA) Scalable Reliable Datagram (SRD) configuration.
" } }, "com.amazonaws.workspacesinstances#EnaSrdUdpSpecificationRequest": { "type": "structure", "members": { "EnaSrdUdpEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables or disables ENA SRD for UDP traffic.
" } } }, "traits": { "smithy.api#documentation": "Specifies UDP configuration for ENA SRD.
" } }, "com.amazonaws.workspacesinstances#EnclaveOptionsRequest": { "type": "structure", "members": { "Enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables or disables AWS Nitro Enclaves for enhanced security.
" } } }, "traits": { "smithy.api#documentation": "Configures AWS Nitro Enclave options for the WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#GetWorkspaceInstance": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#GetWorkspaceInstanceRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#GetWorkspaceInstanceResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get details for a specific workspace managed instance in your account" }, "smithy.api#documentation": "Retrieves detailed information about a specific WorkSpace Instance.
", "smithy.api#readonly": {} } }, "com.amazonaws.workspacesinstances#GetWorkspaceInstanceRequest": { "type": "structure", "members": { "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "Unique identifier of the WorkSpace Instance to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Identifies the WorkSpaces Instance to retrieve detailed information for.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#GetWorkspaceInstanceResponse": { "type": "structure", "members": { "WorkspaceInstanceErrors": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceErrors", "traits": { "smithy.api#documentation": "Captures any errors specific to the WorkSpace Instance lifecycle.
" } }, "EC2InstanceErrors": { "target": "com.amazonaws.workspacesinstances#EC2InstanceErrors", "traits": { "smithy.api#documentation": "Includes any underlying EC2 instance errors encountered.
" } }, "ProvisionState": { "target": "com.amazonaws.workspacesinstances#ProvisionStateEnum", "traits": { "smithy.api#documentation": "Current provisioning state of the WorkSpaces Instance.
" } }, "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "Unique identifier of the retrieved WorkSpaces Instance.
" } }, "EC2ManagedInstance": { "target": "com.amazonaws.workspacesinstances#EC2ManagedInstance", "traits": { "smithy.api#documentation": "Details of the associated EC2 managed instance.
" } }, "BillingConfiguration": { "target": "com.amazonaws.workspacesinstances#BillingConfiguration", "traits": { "smithy.api#documentation": "Returns the current billing configuration for the WorkSpace Instance, indicating the active billing mode.
" } } }, "traits": { "smithy.api#documentation": "Provides comprehensive details about the requested WorkSpaces Instance.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#HibernationOptionsRequest": { "type": "structure", "members": { "Configured": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables or disables instance hibernation capability.
" } } }, "traits": { "smithy.api#documentation": "Defines hibernation configuration for the WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#HostId": { "type": "string", "traits": { "smithy.api#pattern": "^h-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#HostnameTypeEnum": { "type": "enum", "members": { "IP_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ip-name" } }, "RESOURCE_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "resource-name" } } } }, "com.amazonaws.workspacesinstances#HttpEndpointEnum": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.workspacesinstances#HttpProtocolIpv6Enum": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.workspacesinstances#HttpPutResponseHopLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 64 } } }, "com.amazonaws.workspacesinstances#HttpTokensEnum": { "type": "enum", "members": { "OPTIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "optional" } }, "REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "required" } } } }, "com.amazonaws.workspacesinstances#IamInstanceProfileSpecification": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.workspacesinstances#ARN", "traits": { "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM instance profile.
" } }, "Name": { "target": "com.amazonaws.workspacesinstances#String64", "traits": { "smithy.api#documentation": "Name of the IAM instance profile.
" } } }, "traits": { "smithy.api#documentation": "Defines IAM instance profile configuration for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#ImageId": { "type": "string", "traits": { "smithy.api#pattern": "^ami-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#InstanceConfigurationFilter": { "type": "structure", "members": { "BillingMode": { "target": "com.amazonaws.workspacesinstances#BillingMode", "traits": { "smithy.api#documentation": "Filters WorkSpace Instance types based on supported billing modes. Allows customers to search for instance types that support their preferred billing model, such as HOURLY or MONTHLY billing.
", "smithy.api#required": {} } }, "PlatformType": { "target": "com.amazonaws.workspacesinstances#PlatformTypeEnum", "traits": { "smithy.api#documentation": "Filters WorkSpace Instance types by operating system platform. Allows customers to find instances that support their desired OS, such as Windows, Linux/UNIX, Ubuntu Pro, RHEL, or SUSE.
", "smithy.api#required": {} } }, "Tenancy": { "target": "com.amazonaws.workspacesinstances#InstanceConfigurationTenancyEnum", "traits": { "smithy.api#documentation": "Filters WorkSpace Instance types by tenancy model. Allows customers to find instances that match their tenancy requirements, such as SHARED or DEDICATED.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Defines filtering criteria for WorkSpace Instance type searches. Combines multiple filter conditions including billing mode, platform type, and tenancy to help customers find instance types that meet their specific requirements.
" } }, "com.amazonaws.workspacesinstances#InstanceConfigurationTenancyEnum": { "type": "enum", "members": { "SHARED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHARED" } }, "DEDICATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEDICATED" } } } }, "com.amazonaws.workspacesinstances#InstanceInterruptionBehaviorEnum": { "type": "enum", "members": { "HIBERNATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "hibernate" } }, "STOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stop" } } } }, "com.amazonaws.workspacesinstances#InstanceIpv6Address": { "type": "structure", "members": { "Ipv6Address": { "target": "com.amazonaws.workspacesinstances#Ipv6Address", "traits": { "smithy.api#documentation": "Specific IPv6 address assigned to the instance.
" } }, "IsPrimaryIpv6": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates if this is the primary IPv6 address for the instance.
" } } }, "traits": { "smithy.api#documentation": "Represents an IPv6 address configuration for a WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#InstanceMaintenanceOptionsRequest": { "type": "structure", "members": { "AutoRecovery": { "target": "com.amazonaws.workspacesinstances#AutoRecoveryEnum", "traits": { "smithy.api#documentation": "Enables or disables automatic instance recovery.
" } } }, "traits": { "smithy.api#documentation": "Configures automatic maintenance settings for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#InstanceMarketOptionsRequest": { "type": "structure", "members": { "MarketType": { "target": "com.amazonaws.workspacesinstances#MarketTypeEnum", "traits": { "smithy.api#documentation": "Specifies the type of marketplace for instance deployment.
" } }, "SpotOptions": { "target": "com.amazonaws.workspacesinstances#SpotMarketOptions", "traits": { "smithy.api#documentation": "Configuration options for spot instance deployment.
" } } }, "traits": { "smithy.api#documentation": "Configures marketplace-specific instance deployment options.
" } }, "com.amazonaws.workspacesinstances#InstanceMetadataOptionsRequest": { "type": "structure", "members": { "HttpEndpoint": { "target": "com.amazonaws.workspacesinstances#HttpEndpointEnum", "traits": { "smithy.api#documentation": "Enables or disables HTTP endpoint for instance metadata.
" } }, "HttpProtocolIpv6": { "target": "com.amazonaws.workspacesinstances#HttpProtocolIpv6Enum", "traits": { "smithy.api#documentation": "Configures IPv6 support for instance metadata HTTP protocol.
" } }, "HttpPutResponseHopLimit": { "target": "com.amazonaws.workspacesinstances#HttpPutResponseHopLimit", "traits": { "smithy.api#documentation": "Sets maximum number of network hops for metadata PUT responses.
" } }, "HttpTokens": { "target": "com.amazonaws.workspacesinstances#HttpTokensEnum", "traits": { "smithy.api#documentation": "Configures token requirement for instance metadata retrieval.
" } }, "InstanceMetadataTags": { "target": "com.amazonaws.workspacesinstances#InstanceMetadataTagsEnum", "traits": { "smithy.api#documentation": "Enables or disables instance metadata tags retrieval.
" } } }, "traits": { "smithy.api#documentation": "Defines instance metadata service configuration.
" } }, "com.amazonaws.workspacesinstances#InstanceMetadataTagsEnum": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.workspacesinstances#InstanceNetworkInterfaceSpecification": { "type": "structure", "members": { "AssociateCarrierIpAddress": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables carrier IP address association.
" } }, "AssociatePublicIpAddress": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables public IP address assignment.
" } }, "ConnectionTrackingSpecification": { "target": "com.amazonaws.workspacesinstances#ConnectionTrackingSpecificationRequest", "traits": { "smithy.api#documentation": "Configures network connection tracking parameters.
" } }, "Description": { "target": "com.amazonaws.workspacesinstances#Description", "traits": { "smithy.api#documentation": "Descriptive text for the network interface.
" } }, "DeviceIndex": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Unique index for the network interface.
" } }, "EnaSrdSpecification": { "target": "com.amazonaws.workspacesinstances#EnaSrdSpecificationRequest", "traits": { "smithy.api#documentation": "Configures Elastic Network Adapter Scalable Reliable Datagram settings.
" } }, "InterfaceType": { "target": "com.amazonaws.workspacesinstances#InterfaceTypeEnum", "traits": { "smithy.api#documentation": "Specifies the type of network interface.
" } }, "Ipv4Prefixes": { "target": "com.amazonaws.workspacesinstances#Ipv4Prefixes", "traits": { "smithy.api#documentation": "IPv4 prefix configurations for the interface.
" } }, "Ipv4PrefixCount": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Number of IPv4 prefixes to assign.
" } }, "Ipv6AddressCount": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Number of IPv6 addresses to assign.
" } }, "Ipv6Addresses": { "target": "com.amazonaws.workspacesinstances#Ipv6Addresses", "traits": { "smithy.api#documentation": "Specific IPv6 addresses for the interface.
" } }, "Ipv6Prefixes": { "target": "com.amazonaws.workspacesinstances#Ipv6Prefixes", "traits": { "smithy.api#documentation": "IPv6 prefix configurations for the interface.
" } }, "Ipv6PrefixCount": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Number of IPv6 prefixes to assign.
" } }, "NetworkCardIndex": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Index of the network card for multiple network interfaces.
" } }, "NetworkInterfaceId": { "target": "com.amazonaws.workspacesinstances#NetworkInterfaceId", "traits": { "smithy.api#documentation": "Unique identifier for the network interface.
" } }, "PrimaryIpv6": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates the primary IPv6 configuration.
" } }, "PrivateIpAddress": { "target": "com.amazonaws.workspacesinstances#Ipv4Address", "traits": { "smithy.api#documentation": "Primary private IP address for the interface.
" } }, "PrivateIpAddresses": { "target": "com.amazonaws.workspacesinstances#PrivateIpAddresses", "traits": { "smithy.api#documentation": "List of private IP addresses for the interface.
" } }, "SecondaryPrivateIpAddressCount": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Number of additional private IP addresses to assign.
" } }, "Groups": { "target": "com.amazonaws.workspacesinstances#SecurityGroupIds", "traits": { "smithy.api#documentation": "Security groups associated with the network interface.
" } }, "SubnetId": { "target": "com.amazonaws.workspacesinstances#SubnetId", "traits": { "smithy.api#documentation": "Subnet identifier for the network interface.
" } } }, "traits": { "smithy.api#documentation": "Defines network interface configuration for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#InstanceNetworkPerformanceOptionsRequest": { "type": "structure", "members": { "BandwidthWeighting": { "target": "com.amazonaws.workspacesinstances#BandwidthWeightingEnum", "traits": { "smithy.api#documentation": "Defines bandwidth allocation strategy for network interfaces.
" } } }, "traits": { "smithy.api#documentation": "Configures network performance settings for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#InstanceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^([a-z0-9-]+)\\.([a-z0-9]+)$" } }, "com.amazonaws.workspacesinstances#InstanceTypeInfo": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.workspacesinstances#InstanceType", "traits": { "smithy.api#documentation": "Unique identifier for the WorkSpace Instance type.
" } }, "SupportedInstanceConfigurations": { "target": "com.amazonaws.workspacesinstances#SupportedInstanceConfigurations", "traits": { "smithy.api#documentation": "Lists all valid combinations of tenancy, platform type, and billing mode supported for the specific WorkSpace Instance type. Contains the complete set of configuration options available for this instance type.
" } } }, "traits": { "smithy.api#documentation": "Provides details about a specific WorkSpace Instance type.
" } }, "com.amazonaws.workspacesinstances#InstanceTypes": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#InstanceTypeInfo" } }, "com.amazonaws.workspacesinstances#InterfaceTypeEnum": { "type": "enum", "members": { "INTERFACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "interface" } }, "EFA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "efa" } }, "EFA_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "efa-only" } } } }, "com.amazonaws.workspacesinstances#InternalServerException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Description of the internal server error.
", "smithy.api#required": {} } }, "RetryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Recommended wait time before retrying the request.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "Indicates an unexpected server-side error occurred.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.workspacesinstances#Ipv4Address": { "type": "string", "traits": { "smithy.api#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}$", "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesinstances#Ipv4Prefix": { "type": "string", "traits": { "smithy.api#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})?" } }, "com.amazonaws.workspacesinstances#Ipv4PrefixSpecificationRequest": { "type": "structure", "members": { "Ipv4Prefix": { "target": "com.amazonaws.workspacesinstances#Ipv4Prefix", "traits": { "smithy.api#documentation": "Specific IPv4 prefix for network interface configuration.
" } } }, "traits": { "smithy.api#documentation": "Specifies IPv4 prefix configuration for network interfaces.
" } }, "com.amazonaws.workspacesinstances#Ipv4Prefixes": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#Ipv4PrefixSpecificationRequest" } }, "com.amazonaws.workspacesinstances#Ipv6Address": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesinstances#Ipv6Addresses": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#InstanceIpv6Address" } }, "com.amazonaws.workspacesinstances#Ipv6Prefix": { "type": "string", "traits": { "smithy.api#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])$" } }, "com.amazonaws.workspacesinstances#Ipv6PrefixSpecificationRequest": { "type": "structure", "members": { "Ipv6Prefix": { "target": "com.amazonaws.workspacesinstances#Ipv6Prefix", "traits": { "smithy.api#documentation": "Specific IPv6 prefix for network interface configuration.
" } } }, "traits": { "smithy.api#documentation": "Specifies IPv6 prefix configuration for network interfaces.
" } }, "com.amazonaws.workspacesinstances#Ipv6Prefixes": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#Ipv6PrefixSpecificationRequest" } }, "com.amazonaws.workspacesinstances#KmsKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesinstances#LicenseConfigurationRequest": { "type": "structure", "members": { "LicenseConfigurationArn": { "target": "com.amazonaws.workspacesinstances#ARN", "traits": { "smithy.api#documentation": "ARN of the license configuration for the WorkSpace Instance.
" } } }, "traits": { "smithy.api#documentation": "Specifies license configuration for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#LicenseSpecifications": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#LicenseConfigurationRequest" } }, "com.amazonaws.workspacesinstances#ListInstanceTypes": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#ListInstanceTypesRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#ListInstanceTypesResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all supported instance types" }, "smithy.api#documentation": "Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "InstanceTypes" }, "smithy.api#readonly": {} } }, "com.amazonaws.workspacesinstances#ListInstanceTypesMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 600 } } }, "com.amazonaws.workspacesinstances#ListInstanceTypesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.workspacesinstances#ListInstanceTypesMaxResults", "traits": { "smithy.api#documentation": "Maximum number of instance types to return in a single API call. Enables pagination of instance type results.
" } }, "NextToken": { "target": "com.amazonaws.workspacesinstances#NextToken", "traits": { "smithy.api#documentation": "Pagination token for retrieving subsequent pages of instance type results.
" } }, "InstanceConfigurationFilter": { "target": "com.amazonaws.workspacesinstances#InstanceConfigurationFilter", "traits": { "smithy.api#documentation": "Optional filter to narrow instance type results based on configuration requirements. Only returns instance types that support the specified combination of tenancy, platform type, and billing mode.
" } } }, "traits": { "smithy.api#documentation": "Defines input parameters for retrieving supported WorkSpaces Instances instance types.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#ListInstanceTypesResponse": { "type": "structure", "members": { "InstanceTypes": { "target": "com.amazonaws.workspacesinstances#InstanceTypes", "traits": { "smithy.api#documentation": "Collection of supported instance types for WorkSpaces Instances.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.workspacesinstances#NextToken", "traits": { "smithy.api#documentation": "Token for retrieving additional instance types if the result set is paginated.
" } } }, "traits": { "smithy.api#documentation": "Contains the list of instance types supported by WorkSpaces Instances.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#ListRegions": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#ListRegionsRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#ListRegionsResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all supported AWS regions" }, "smithy.api#documentation": "Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Regions" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListRegionsSuccess", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.workspacesinstances#ListRegionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.workspacesinstances#MaxResults", "traits": { "smithy.api#documentation": "Maximum number of regions to return in a single API call. Enables pagination of region results.
" } }, "NextToken": { "target": "com.amazonaws.workspacesinstances#NextToken", "traits": { "smithy.api#documentation": "Pagination token for retrieving subsequent pages of region results.
" } } }, "traits": { "smithy.api#documentation": "Defines input parameters for retrieving supported WorkSpaces Instances regions.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#ListRegionsResponse": { "type": "structure", "members": { "Regions": { "target": "com.amazonaws.workspacesinstances#RegionList", "traits": { "smithy.api#documentation": "Collection of AWS regions supported by WorkSpaces Instances.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.workspacesinstances#NextToken", "traits": { "smithy.api#documentation": "Token for retrieving additional regions if the result set is paginated.
" } } }, "traits": { "smithy.api#documentation": "Contains the list of supported AWS regions for WorkSpaces Instances.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list user tags for resources in your account" }, "smithy.api#documentation": "Retrieves tags for a WorkSpace Instance.
", "smithy.api#readonly": {} } }, "com.amazonaws.workspacesinstances#ListTagsForResourceRequest": { "type": "structure", "members": { "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "Unique identifier of the WorkSpace Instance.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the WorkSpace Instance to retrieve tags for.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.workspacesinstances#TagList", "traits": { "smithy.api#documentation": "Collection of tags associated with the WorkSpace Instance.
" } } }, "traits": { "smithy.api#documentation": "Returns the list of tags for the specified WorkSpace Instance.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#ListWorkspaceInstances": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#ListWorkspaceInstancesRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#ListWorkspaceInstancesResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list workspace managed instances in your account" }, "smithy.api#documentation": "Retrieves a collection of WorkSpaces Instances based on specified filters.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "WorkspaceInstances" }, "smithy.api#readonly": {} } }, "com.amazonaws.workspacesinstances#ListWorkspaceInstancesRequest": { "type": "structure", "members": { "ProvisionStates": { "target": "com.amazonaws.workspacesinstances#ProvisionStates", "traits": { "smithy.api#documentation": "Filter WorkSpaces Instances by their current provisioning states.
" } }, "MaxResults": { "target": "com.amazonaws.workspacesinstances#MaxResults", "traits": { "smithy.api#documentation": "Maximum number of WorkSpaces Instances to return in a single response.
" } }, "NextToken": { "target": "com.amazonaws.workspacesinstances#NextToken", "traits": { "smithy.api#documentation": "Pagination token for retrieving subsequent pages of WorkSpaces Instances.
" } } }, "traits": { "smithy.api#documentation": "Defines filters and pagination parameters for retrieving WorkSpaces Instances.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#ListWorkspaceInstancesResponse": { "type": "structure", "members": { "WorkspaceInstances": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstances", "traits": { "smithy.api#documentation": "Collection of WorkSpaces Instances returned by the query.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.workspacesinstances#NextToken", "traits": { "smithy.api#documentation": "Token for retrieving additional WorkSpaces Instances if the result set is paginated.
" } } }, "traits": { "smithy.api#documentation": "Contains the list of WorkSpaces Instances matching the specified criteria.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#ManagedInstanceRequest": { "type": "structure", "members": { "BlockDeviceMappings": { "target": "com.amazonaws.workspacesinstances#BlockDeviceMappings", "traits": { "smithy.api#documentation": "Configures block device mappings for storage.
" } }, "CapacityReservationSpecification": { "target": "com.amazonaws.workspacesinstances#CapacityReservationSpecification", "traits": { "smithy.api#documentation": "Specifies capacity reservation preferences.
" } }, "CpuOptions": { "target": "com.amazonaws.workspacesinstances#CpuOptionsRequest", "traits": { "smithy.api#documentation": "Configures CPU-specific settings.
" } }, "CreditSpecification": { "target": "com.amazonaws.workspacesinstances#CreditSpecificationRequest", "traits": { "smithy.api#documentation": "Defines CPU credit configuration for burstable instances.
" } }, "DisableApiStop": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Prevents API-initiated instance stop.
" } }, "EbsOptimized": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables optimized EBS performance.
" } }, "EnablePrimaryIpv6": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables primary IPv6 address configuration.
" } }, "EnclaveOptions": { "target": "com.amazonaws.workspacesinstances#EnclaveOptionsRequest", "traits": { "smithy.api#documentation": "Configures AWS Nitro Enclave settings.
" } }, "HibernationOptions": { "target": "com.amazonaws.workspacesinstances#HibernationOptionsRequest", "traits": { "smithy.api#documentation": "Configures instance hibernation capabilities.
" } }, "IamInstanceProfile": { "target": "com.amazonaws.workspacesinstances#IamInstanceProfileSpecification", "traits": { "smithy.api#documentation": "Specifies IAM instance profile configuration.
" } }, "ImageId": { "target": "com.amazonaws.workspacesinstances#ImageId", "traits": { "smithy.api#documentation": "Identifies the Amazon Machine Image (AMI) for the instance.
" } }, "InstanceMarketOptions": { "target": "com.amazonaws.workspacesinstances#InstanceMarketOptionsRequest", "traits": { "smithy.api#documentation": "Configures marketplace-specific deployment options.
" } }, "InstanceType": { "target": "com.amazonaws.workspacesinstances#InstanceType", "traits": { "smithy.api#documentation": "Specifies the WorkSpace Instance type.
" } }, "Ipv6Addresses": { "target": "com.amazonaws.workspacesinstances#Ipv6Addresses", "traits": { "smithy.api#documentation": "Configures specific IPv6 addresses.
" } }, "Ipv6AddressCount": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Specifies number of IPv6 addresses to assign.
" } }, "KernelId": { "target": "com.amazonaws.workspacesinstances#String128", "traits": { "smithy.api#documentation": "Identifies the kernel for the instance.
" } }, "KeyName": { "target": "com.amazonaws.workspacesinstances#String64", "traits": { "smithy.api#documentation": "Specifies the key pair for instance access.
" } }, "LicenseSpecifications": { "target": "com.amazonaws.workspacesinstances#LicenseSpecifications", "traits": { "smithy.api#documentation": "Configures license-related settings.
" } }, "MaintenanceOptions": { "target": "com.amazonaws.workspacesinstances#InstanceMaintenanceOptionsRequest", "traits": { "smithy.api#documentation": "Defines automatic maintenance settings.
" } }, "MetadataOptions": { "target": "com.amazonaws.workspacesinstances#InstanceMetadataOptionsRequest", "traits": { "smithy.api#documentation": "Configures instance metadata service settings.
" } }, "Monitoring": { "target": "com.amazonaws.workspacesinstances#RunInstancesMonitoringEnabled", "traits": { "smithy.api#documentation": "Enables or disables detailed instance monitoring.
" } }, "NetworkInterfaces": { "target": "com.amazonaws.workspacesinstances#NetworkInterfaces", "traits": { "smithy.api#documentation": "Configures network interface settings.
" } }, "NetworkPerformanceOptions": { "target": "com.amazonaws.workspacesinstances#InstanceNetworkPerformanceOptionsRequest", "traits": { "smithy.api#documentation": "Defines network performance configuration.
" } }, "Placement": { "target": "com.amazonaws.workspacesinstances#Placement", "traits": { "smithy.api#documentation": "Specifies instance placement preferences.
" } }, "PrivateDnsNameOptions": { "target": "com.amazonaws.workspacesinstances#PrivateDnsNameOptionsRequest", "traits": { "smithy.api#documentation": "Configures private DNS name settings.
" } }, "PrivateIpAddress": { "target": "com.amazonaws.workspacesinstances#Ipv4Address", "traits": { "smithy.api#documentation": "Specifies the primary private IP address.
" } }, "RamdiskId": { "target": "com.amazonaws.workspacesinstances#String128", "traits": { "smithy.api#documentation": "Identifies the ramdisk for the instance.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.workspacesinstances#SecurityGroupIds", "traits": { "smithy.api#documentation": "Specifies security group identifiers.
" } }, "SecurityGroups": { "target": "com.amazonaws.workspacesinstances#SecurityGroupNames", "traits": { "smithy.api#documentation": "Configures security group settings.
" } }, "SubnetId": { "target": "com.amazonaws.workspacesinstances#SubnetId", "traits": { "smithy.api#documentation": "Identifies the subnet for the instance.
" } }, "TagSpecifications": { "target": "com.amazonaws.workspacesinstances#TagSpecifications", "traits": { "smithy.api#documentation": "Configures resource tagging specifications.
" } }, "UserData": { "target": "com.amazonaws.workspacesinstances#UserData", "traits": { "smithy.api#documentation": "Provides custom initialization data for the instance.
" } } }, "traits": { "smithy.api#documentation": "Defines comprehensive configuration for a managed WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#MarketTypeEnum": { "type": "enum", "members": { "SPOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "spot" } }, "CAPACITY_BLOCK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "capacity-block" } } } }, "com.amazonaws.workspacesinstances#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 25 } } }, "com.amazonaws.workspacesinstances#ModifyVolume": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#ModifyVolumeRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#ModifyVolumeResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#ConflictException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ServiceQuotaExceededException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" }, { "target": "com.amazonaws.workspacesinstances#VolumeModificationRateExceededException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to modify a workspace managed volume in your account" }, "smithy.api#documentation": "Modifies the size, volume type, IOPS (input/output operations per second), or throughput of a volume. When you modify a volume, you must specify at least one of these parameters. You can modify a volume only after any previous modification for that volume has finished.
To track the progress of a modification, use the Amazon EC2 DescribeVolumesModifications operation. For more information, see Monitor the progress of Amazon EBS volume modifications in the Amazon EBS User Guide.
After you increase the size of a volume, you must extend the partition and file system to use the new storage capacity. For more information, see Extend the file system after resizing an Amazon EBS volume in the Amazon EBS User Guide, which covers both Linux and Windows instances.
", "smithy.api#idempotent": {} } }, "com.amazonaws.workspacesinstances#ModifyVolumeRequest": { "type": "structure", "members": { "VolumeId": { "target": "com.amazonaws.workspacesinstances#VolumeId", "traits": { "smithy.api#documentation": "Specifies the identifier of the volume to modify.
", "smithy.api#required": {} } }, "SizeInGB": { "target": "com.amazonaws.workspacesinstances#VolumeSizeInGB", "traits": { "smithy.api#documentation": "Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.
" } }, "VolumeType": { "target": "com.amazonaws.workspacesinstances#VolumeTypeEnum", "traits": { "smithy.api#documentation": "Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.
" } }, "Iops": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Specifies the target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.
Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. If you don't specify throughput and the volume remains gp3, the current throughput is retained.
Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for modifying a volume, including the target size, volume type, IOPS, or throughput.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#ModifyVolumeResponse": { "type": "structure", "members": { "VolumeId": { "target": "com.amazonaws.workspacesinstances#VolumeId", "traits": { "smithy.api#documentation": "Specifies the identifier of the modified volume.
" } }, "TargetSize": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Specifies the target size of the volume, in GiB.
" } }, "TargetVolumeType": { "target": "com.amazonaws.workspacesinstances#VolumeTypeEnum", "traits": { "smithy.api#documentation": "Specifies the target Amazon EBS volume type.
" } }, "TargetIops": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Specifies the target IOPS rate of the volume.
" } }, "TargetThroughput": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Specifies the target throughput of the volume, in MiB/s.
" } } }, "traits": { "smithy.api#documentation": "Contains the target configuration of the volume after the modification, including the size, volume type, IOPS, and throughput where applicable.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#NestedVirtualizationEnum": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.workspacesinstances#NetworkInterfaceId": { "type": "string", "traits": { "smithy.api#pattern": "^eni-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#NetworkInterfaces": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#InstanceNetworkInterfaceSpecification" } }, "com.amazonaws.workspacesinstances#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesinstances#NonNegativeInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.workspacesinstances#Placement": { "type": "structure", "members": { "Affinity": { "target": "com.amazonaws.workspacesinstances#String64", "traits": { "smithy.api#documentation": "Specifies host affinity for dedicated instances.
" } }, "AvailabilityZone": { "target": "com.amazonaws.workspacesinstances#AvailabilityZone", "traits": { "smithy.api#documentation": "Identifies the specific AWS availability zone.
" } }, "GroupId": { "target": "com.amazonaws.workspacesinstances#PlacementGroupId", "traits": { "smithy.api#documentation": "Unique identifier for placement group.
" } }, "GroupName": { "target": "com.amazonaws.workspacesinstances#String64", "traits": { "smithy.api#documentation": "Name of the placement group.
" } }, "HostId": { "target": "com.amazonaws.workspacesinstances#HostId", "traits": { "smithy.api#documentation": "Identifies the specific dedicated host.
" } }, "HostResourceGroupArn": { "target": "com.amazonaws.workspacesinstances#ARN", "traits": { "smithy.api#documentation": "ARN of the host resource group.
" } }, "PartitionNumber": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Specifies partition number for partition placement groups.
" } }, "Tenancy": { "target": "com.amazonaws.workspacesinstances#TenancyEnum", "traits": { "smithy.api#documentation": "Defines instance tenancy configuration.
" } } }, "traits": { "smithy.api#documentation": "Defines instance placement configuration for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#PlacementGroupId": { "type": "string", "traits": { "smithy.api#pattern": "^pg-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#PlatformTypeEnum": { "type": "enum", "members": { "WINDOWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Windows" } }, "WINDOWS_BYOL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Windows BYOL" } }, "LINUX_UNIX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Linux/UNIX" } }, "UBUNTU_PRO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Ubuntu Pro Linux" } }, "RHEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Red Hat Enterprise Linux" } }, "LINUX_BYOL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Red Hat BYOL Linux" } }, "SUSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSE Linux" } } } }, "com.amazonaws.workspacesinstances#PrivateDnsNameOptionsRequest": { "type": "structure", "members": { "HostnameType": { "target": "com.amazonaws.workspacesinstances#HostnameTypeEnum", "traits": { "smithy.api#documentation": "Specifies the type of hostname configuration.
" } }, "EnableResourceNameDnsARecord": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables DNS A record for resource name resolution.
" } }, "EnableResourceNameDnsAAAARecord": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables DNS AAAA record for resource name resolution.
" } } }, "traits": { "smithy.api#documentation": "Configures private DNS name settings for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#PrivateIpAddressSpecification": { "type": "structure", "members": { "Primary": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates if this is the primary private IP address.
" } }, "PrivateIpAddress": { "target": "com.amazonaws.workspacesinstances#Ipv4Address", "traits": { "smithy.api#documentation": "Specific private IP address for the network interface.
" } } }, "traits": { "smithy.api#documentation": "Defines private IP address configuration for network interface.
" } }, "com.amazonaws.workspacesinstances#PrivateIpAddresses": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#PrivateIpAddressSpecification" } }, "com.amazonaws.workspacesinstances#ProvisionStateEnum": { "type": "enum", "members": { "ALLOCATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOCATING" } }, "ALLOCATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOCATED" } }, "DEALLOCATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEALLOCATING" } }, "DEALLOCATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEALLOCATED" } }, "ERROR_ALLOCATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_ALLOCATING" } }, "ERROR_DEALLOCATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_DEALLOCATING" } } } }, "com.amazonaws.workspacesinstances#ProvisionStates": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#ProvisionStateEnum" } }, "com.amazonaws.workspacesinstances#Region": { "type": "structure", "members": { "RegionName": { "target": "com.amazonaws.workspacesinstances#RegionName", "traits": { "smithy.api#documentation": "Name of the AWS region.
" } } }, "traits": { "smithy.api#documentation": "Represents an AWS region supported by WorkSpaces Instances.
" } }, "com.amazonaws.workspacesinstances#RegionList": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#Region" } }, "com.amazonaws.workspacesinstances#RegionName": { "type": "string", "traits": { "smithy.api#pattern": "^[-0-9a-z]{1,31}$" } }, "com.amazonaws.workspacesinstances#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Details about the missing resource.
", "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Identifier of the resource that was not found.
", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Type of the resource that was not found.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Indicates the requested resource could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.workspacesinstances#ResourceTypeEnum": { "type": "enum", "members": { "INSTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "instance" } }, "VOLUME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "volume" } }, "SPOT_INSTANCES_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "spot-instances-request" } }, "NETWORK_INTERFACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "network-interface" } } } }, "com.amazonaws.workspacesinstances#RunInstancesMonitoringEnabled": { "type": "structure", "members": { "Enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enables or disables detailed instance monitoring.
" } } }, "traits": { "smithy.api#documentation": "Configures detailed monitoring for WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#SecurityGroupId": { "type": "string", "traits": { "smithy.api#pattern": "^sg-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#SecurityGroupIds": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#SecurityGroupId" } }, "com.amazonaws.workspacesinstances#SecurityGroupName": { "type": "string", "traits": { "smithy.api#pattern": "^(?!sg-)[\\w .:/()#,@\\[\\]+=&;{}!$*-]{0,255}$" } }, "com.amazonaws.workspacesinstances#SecurityGroupNames": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#SecurityGroupName" } }, "com.amazonaws.workspacesinstances#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Description of the quota limitation.
", "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Identifier of the resource related to the quota.
", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Type of resource related to the quota.
", "smithy.api#required": {} } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Code identifying the service with the quota limitation.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specific code for the exceeded quota.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Indicates that a service quota has been exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.workspacesinstances#SnapshotId": { "type": "string", "traits": { "smithy.api#pattern": "^snap-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#SpotInstanceTypeEnum": { "type": "enum", "members": { "ONE_TIME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "one-time" } }, "PERSISTENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "persistent" } } } }, "com.amazonaws.workspacesinstances#SpotMarketOptions": { "type": "structure", "members": { "BlockDurationMinutes": { "target": "com.amazonaws.workspacesinstances#NonNegativeInteger", "traits": { "smithy.api#documentation": "Duration of spot instance block reservation.
" } }, "InstanceInterruptionBehavior": { "target": "com.amazonaws.workspacesinstances#InstanceInterruptionBehaviorEnum", "traits": { "smithy.api#documentation": "Specifies behavior when spot instance is interrupted.
" } }, "MaxPrice": { "target": "com.amazonaws.workspacesinstances#String64", "traits": { "smithy.api#documentation": "Maximum hourly price for spot instance.
" } }, "SpotInstanceType": { "target": "com.amazonaws.workspacesinstances#SpotInstanceTypeEnum", "traits": { "smithy.api#documentation": "Defines the type of spot instance request.
" } }, "ValidUntilUtc": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Timestamp until which spot instance request is valid.
" } } }, "traits": { "smithy.api#documentation": "Defines configuration for spot instance deployment.
" } }, "com.amazonaws.workspacesinstances#String128": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 } } }, "com.amazonaws.workspacesinstances#String64": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 } } }, "com.amazonaws.workspacesinstances#SubnetId": { "type": "string", "traits": { "smithy.api#pattern": "^subnet-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#SupportedInstanceConfiguration": { "type": "structure", "members": { "BillingMode": { "target": "com.amazonaws.workspacesinstances#BillingMode", "traits": { "smithy.api#documentation": "Specifies the billing mode supported in this configuration combination.
" } }, "PlatformType": { "target": "com.amazonaws.workspacesinstances#PlatformTypeEnum", "traits": { "smithy.api#documentation": "Specifies the operating system platform supported in this configuration combination.
" } }, "Tenancy": { "target": "com.amazonaws.workspacesinstances#InstanceConfigurationTenancyEnum", "traits": { "smithy.api#documentation": "Specifies the tenancy model supported in this configuration combination.
" } } }, "traits": { "smithy.api#documentation": "Represents a single valid configuration combination that an instance type supports, combining tenancy, platform type, and billing mode into one complete configuration specification.
" } }, "com.amazonaws.workspacesinstances#SupportedInstanceConfigurations": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#SupportedInstanceConfiguration" } }, "com.amazonaws.workspacesinstances#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.workspacesinstances#TagKey", "traits": { "smithy.api#documentation": "Unique identifier for the tag.
" } }, "Value": { "target": "com.amazonaws.workspacesinstances#TagValue", "traits": { "smithy.api#documentation": "Value associated with the tag key.
" } } }, "traits": { "smithy.api#documentation": "Represents a key-value metadata tag.
" } }, "com.amazonaws.workspacesinstances#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" } }, "com.amazonaws.workspacesinstances#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.workspacesinstances#TagList": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.workspacesinstances#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#TagResourceRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to add user tags to resources in your account" }, "smithy.api#documentation": "Adds tags to a WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#TagResourceRequest": { "type": "structure", "members": { "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "Unique identifier of the WorkSpace Instance to tag.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.workspacesinstances#TagList", "traits": { "smithy.api#documentation": "Tags to be added to the WorkSpace Instance.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies tags to add to a WorkSpace Instance.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Confirms successful tag addition.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#TagSpecification": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.workspacesinstances#ResourceTypeEnum", "traits": { "smithy.api#documentation": "Type of resource being tagged.
" } }, "Tags": { "target": "com.amazonaws.workspacesinstances#TagList", "traits": { "smithy.api#documentation": "Collection of tags for the specified resource.
" } } }, "traits": { "smithy.api#documentation": "Defines tagging configuration for a resource.
" } }, "com.amazonaws.workspacesinstances#TagSpecifications": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#TagSpecification" }, "traits": { "smithy.api#length": { "max": 30 } } }, "com.amazonaws.workspacesinstances#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.workspacesinstances#TenancyEnum": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "default" } }, "DEDICATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dedicated" } }, "HOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "host" } } } }, "com.amazonaws.workspacesinstances#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Description of the throttling event.
", "smithy.api#required": {} } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Code identifying the service experiencing throttling.
" } }, "QuotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specific code for the throttling quota.
" } }, "RetryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Recommended wait time before retrying the request.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "Indicates the request rate has exceeded limits.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.workspacesinstances#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.workspacesinstances#UntagResourceRequest" }, "output": { "target": "com.amazonaws.workspacesinstances#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.workspacesinstances#AccessDeniedException" }, { "target": "com.amazonaws.workspacesinstances#InternalServerException" }, { "target": "com.amazonaws.workspacesinstances#ResourceNotFoundException" }, { "target": "com.amazonaws.workspacesinstances#ThrottlingException" }, { "target": "com.amazonaws.workspacesinstances#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to remove user tags from resources in your account" }, "smithy.api#documentation": "Removes tags from a WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#UntagResourceRequest": { "type": "structure", "members": { "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "Unique identifier of the WorkSpace Instance to untag.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.workspacesinstances#TagKeyList", "traits": { "smithy.api#documentation": "Keys of tags to be removed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies tags to remove from a WorkSpace Instance.
", "smithy.api#input": {} } }, "com.amazonaws.workspacesinstances#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Confirms successful tag removal.
", "smithy.api#output": {} } }, "com.amazonaws.workspacesinstances#UserData": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 16000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesinstances#ValidationException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Overall description of validation failures.
", "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.workspacesinstances#ValidationExceptionReason", "traits": { "smithy.api#documentation": "Specific reason for the validation failure.
", "smithy.api#required": {} } }, "FieldList": { "target": "com.amazonaws.workspacesinstances#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "List of fields that failed validation.
" } } }, "traits": { "smithy.api#documentation": "Indicates invalid input parameters in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.workspacesinstances#ValidationExceptionField": { "type": "structure", "members": { "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of the field that failed validation.
", "smithy.api#required": {} } }, "Reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Reason for the validation failure.
", "smithy.api#required": {} } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Detailed error message describing the validation issue.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a validation error field in an API request.
" } }, "com.amazonaws.workspacesinstances#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#ValidationExceptionField" } }, "com.amazonaws.workspacesinstances#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_OPERATION" } }, "UNSUPPORTED_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_OPERATION" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANNOT_PARSE" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" } }, "DEPENDENCY_FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPENDENCY_FAILURE" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } } }, "com.amazonaws.workspacesinstances#VirtualName": { "type": "string", "traits": { "smithy.api#pattern": "^ephemeral(0|[1-9][0-9]{0,2})$" } }, "com.amazonaws.workspacesinstances#VolumeId": { "type": "string", "traits": { "smithy.api#pattern": "^vol-[0-9a-zA-Z]{1,63}$" } }, "com.amazonaws.workspacesinstances#VolumeModificationRateExceededException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the reason that the modification request was rejected.
", "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the identifier of the volume for which the modification request was rejected.
", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the type of the resource for which the modification request was rejected.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The volume has a previous modification that is still in progress, or has reached the limit of four modifications in a rolling 24-hour period. Wait for the current modification to finish, or wait until the time indicated in the error message, and then retry the request.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.workspacesinstances#VolumeSizeInGB": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 16384 } } }, "com.amazonaws.workspacesinstances#VolumeTypeEnum": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "standard" } }, "IO1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "io1" } }, "IO2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "io2" } }, "GP2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gp2" } }, "SC1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sc1" } }, "ST1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "st1" } }, "GP3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gp3" } } } }, "com.amazonaws.workspacesinstances#WorkspaceInstance": { "type": "structure", "members": { "ProvisionState": { "target": "com.amazonaws.workspacesinstances#ProvisionStateEnum", "traits": { "smithy.api#documentation": "Current provisioning state of the WorkSpace Instance.
" } }, "WorkspaceInstanceId": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceId", "traits": { "smithy.api#documentation": "Unique identifier for the WorkSpace Instance.
" } }, "EC2ManagedInstance": { "target": "com.amazonaws.workspacesinstances#EC2ManagedInstance", "traits": { "smithy.api#documentation": "Details of the associated EC2 managed instance.
" } } }, "traits": { "smithy.api#documentation": "Represents a single WorkSpace Instance.
" } }, "com.amazonaws.workspacesinstances#WorkspaceInstanceError": { "type": "structure", "members": { "ErrorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Unique error code for the WorkSpace Instance error.
" } }, "ErrorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Detailed description of the WorkSpace Instance error.
" } } }, "traits": { "smithy.api#documentation": "Captures errors specific to WorkSpace Instance operations.
" } }, "com.amazonaws.workspacesinstances#WorkspaceInstanceErrors": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstanceError" } }, "com.amazonaws.workspacesinstances#WorkspaceInstanceId": { "type": "string", "traits": { "smithy.api#length": { "min": 15, "max": 70 }, "smithy.api#pattern": "^wsinst-[0-9a-zA-Z]{8,63}$" } }, "com.amazonaws.workspacesinstances#WorkspaceInstances": { "type": "list", "member": { "target": "com.amazonaws.workspacesinstances#WorkspaceInstance" } } } }