WorkspacesInstances ******************* Client ====== class WorkspacesInstances.Client A low-level client representing Amazon Workspaces Instances Amazon WorkSpaces Instances provides an API framework for managing virtual workspace environments across multiple AWS regions, enabling programmatic creation and configuration of desktop infrastructure. import boto3 client = boto3.client('workspaces-instances') These are the available methods: * associate_volume * can_paginate * close * create_volume * create_workspace_instance * delete_volume * delete_workspace_instance * disassociate_volume * get_paginator * get_waiter * get_workspace_instance * list_instance_types * list_regions * list_tags_for_resource * list_workspace_instances * tag_resource * untag_resource Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListInstanceTypes * ListRegions * ListWorkspaceInstances WorkspacesInstances / Paginator / ListInstanceTypes ListInstanceTypes ***************** class WorkspacesInstances.Paginator.ListInstanceTypes paginator = client.get_paginator('list_instance_types') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkspacesInstances.Client.list_instance_types()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceTypes': [ { 'InstanceType': 'string' }, ], } **Response Structure** * *(dict) --* Contains the list of instance types supported by WorkSpaces Instances. * **InstanceTypes** *(list) --* Collection of supported instance types for WorkSpaces Instances. * *(dict) --* Provides details about a specific WorkSpace Instance type. * **InstanceType** *(string) --* Unique identifier for the WorkSpace Instance type. WorkspacesInstances / Paginator / ListWorkspaceInstances ListWorkspaceInstances ********************** class WorkspacesInstances.Paginator.ListWorkspaceInstances paginator = client.get_paginator('list_workspace_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkspacesInstances.Client.list_workspace_instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProvisionStates=[ 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProvisionStates** (*list*) -- Filter WorkSpaces Instances by their current provisioning states. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'WorkspaceInstances': [ { 'ProvisionState': 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING', 'WorkspaceInstanceId': 'string', 'EC2ManagedInstance': { 'InstanceId': 'string' } }, ], } **Response Structure** * *(dict) --* Contains the list of WorkSpaces Instances matching the specified criteria. * **WorkspaceInstances** *(list) --* Collection of WorkSpaces Instances returned by the query. * *(dict) --* Represents a single WorkSpace Instance. * **ProvisionState** *(string) --* Current provisioning state of the WorkSpace Instance. * **WorkspaceInstanceId** *(string) --* Unique identifier for the WorkSpace Instance. * **EC2ManagedInstance** *(dict) --* Details of the associated EC2 managed instance. * **InstanceId** *(string) --* Unique identifier of the managed EC2 instance. WorkspacesInstances / Paginator / ListRegions ListRegions *********** class WorkspacesInstances.Paginator.ListRegions paginator = client.get_paginator('list_regions') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkspacesInstances.Client.list_regions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Regions': [ { 'RegionName': 'string' }, ], } **Response Structure** * *(dict) --* Contains the list of supported AWS regions for WorkSpaces Instances. * **Regions** *(list) --* Collection of AWS regions supported by WorkSpaces Instances. * *(dict) --* Represents an AWS region supported by WorkSpaces Instances. * **RegionName** *(string) --* Name of the AWS region. WorkspacesInstances / Client / get_paginator get_paginator ************* WorkspacesInstances.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. WorkspacesInstances / Client / list_workspace_instances list_workspace_instances ************************ WorkspacesInstances.Client.list_workspace_instances(**kwargs) Retrieves a collection of WorkSpaces Instances based on specified filters. See also: AWS API Documentation **Request Syntax** response = client.list_workspace_instances( ProvisionStates=[ 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING', ], MaxResults=123, NextToken='string' ) Parameters: * **ProvisionStates** (*list*) -- Filter WorkSpaces Instances by their current provisioning states. * *(string) --* * **MaxResults** (*integer*) -- Maximum number of WorkSpaces Instances to return in a single response. * **NextToken** (*string*) -- Pagination token for retrieving subsequent pages of WorkSpaces Instances. Return type: dict Returns: **Response Syntax** { 'WorkspaceInstances': [ { 'ProvisionState': 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING', 'WorkspaceInstanceId': 'string', 'EC2ManagedInstance': { 'InstanceId': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the list of WorkSpaces Instances matching the specified criteria. * **WorkspaceInstances** *(list) --* Collection of WorkSpaces Instances returned by the query. * *(dict) --* Represents a single WorkSpace Instance. * **ProvisionState** *(string) --* Current provisioning state of the WorkSpace Instance. * **WorkspaceInstanceId** *(string) --* Unique identifier for the WorkSpace Instance. * **EC2ManagedInstance** *(dict) --* Details of the associated EC2 managed instance. * **InstanceId** *(string) --* Unique identifier of the managed EC2 instance. * **NextToken** *(string) --* Token for retrieving additional WorkSpaces Instances if the result set is paginated. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" WorkspacesInstances / Client / create_workspace_instance create_workspace_instance ************************* WorkspacesInstances.Client.create_workspace_instance(**kwargs) Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment. See also: AWS API Documentation **Request Syntax** response = client.create_workspace_instance( ClientToken='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], ManagedInstance={ 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'Ebs': { 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'Encrypted': True|False, 'KmsKeyId': 'string', 'Iops': 123, 'Throughput': 123, 'VolumeSize': 123 }, 'NoDevice': 'string', 'VirtualName': 'string' }, ], 'CapacityReservationSpecification': { 'CapacityReservationPreference': 'capacity-reservations-only'|'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, 'CpuOptions': { 'AmdSevSnp': 'enabled'|'disabled', 'CoreCount': 123, 'ThreadsPerCore': 123 }, 'CreditSpecification': { 'CpuCredits': 'standard'|'unlimited' }, 'DisableApiStop': True|False, 'EbsOptimized': True|False, 'EnablePrimaryIpv6': True|False, 'EnclaveOptions': { 'Enabled': True|False }, 'HibernationOptions': { 'Configured': True|False }, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'ImageId': 'string', 'InstanceMarketOptions': { 'MarketType': 'spot'|'capacity-block', 'SpotOptions': { 'BlockDurationMinutes': 123, 'InstanceInterruptionBehavior': 'hibernate'|'stop', 'MaxPrice': 'string', 'SpotInstanceType': 'one-time'|'persistent', 'ValidUntilUtc': datetime(2015, 1, 1) } }, 'InstanceType': 'string', 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'Ipv6AddressCount': 123, 'KernelId': 'string', 'KeyName': 'string', 'LicenseSpecifications': [ { 'LicenseConfigurationArn': 'string' }, ], 'MaintenanceOptions': { 'AutoRecovery': 'disabled'|'default' }, 'MetadataOptions': { 'HttpEndpoint': 'enabled'|'disabled', 'HttpProtocolIpv6': 'enabled'|'disabled', 'HttpPutResponseHopLimit': 123, 'HttpTokens': 'optional'|'required', 'InstanceMetadataTags': 'enabled'|'disabled' }, 'Monitoring': { 'Enabled': True|False }, 'NetworkInterfaces': [ { 'AssociateCarrierIpAddress': True|False, 'AssociatePublicIpAddress': True|False, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'Description': 'string', 'DeviceIndex': 123, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'InterfaceType': 'interface'|'efa'|'efa-only', 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'NetworkCardIndex': 123, 'NetworkInterfaceId': 'string', 'PrimaryIpv6': True|False, 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'Groups': [ 'string', ], 'SubnetId': 'string' }, ], 'NetworkPerformanceOptions': { 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' }, 'Placement': { 'Affinity': 'string', 'AvailabilityZone': 'string', 'GroupId': 'string', 'GroupName': 'string', 'HostId': 'string', 'HostResourceGroupArn': 'string', 'PartitionNumber': 123, 'Tenancy': 'default'|'dedicated'|'host' }, 'PrivateDnsNameOptions': { 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, 'PrivateIpAddress': 'string', 'RamdiskId': 'string', 'SecurityGroupIds': [ 'string', ], 'SecurityGroups': [ 'string', ], 'SubnetId': 'string', 'TagSpecifications': [ { 'ResourceType': 'instance'|'volume'|'spot-instances-request'|'network-interface', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'UserData': 'string' } ) Parameters: * **ClientToken** (*string*) -- Unique token to ensure idempotent instance creation, preventing duplicate workspace launches. This field is autopopulated if not provided. * **Tags** (*list*) -- Optional metadata tags for categorizing and managing WorkSpaces Instances. * *(dict) --* Represents a key-value metadata tag. * **Key** *(string) --* Unique identifier for the tag. * **Value** *(string) --* Value associated with the tag key. * **ManagedInstance** (*dict*) -- **[REQUIRED]** Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters. * **BlockDeviceMappings** *(list) --* Configures block device mappings for storage. * *(dict) --* Defines device mapping for WorkSpace Instance storage. * **DeviceName** *(string) --* Name of the device for storage mapping. * **Ebs** *(dict) --* EBS volume configuration for the device. * **VolumeType** *(string) --* Type of EBS volume (e.g., gp2, io1). * **Encrypted** *(boolean) --* Indicates if the volume is encrypted. * **KmsKeyId** *(string) --* KMS key used for volume encryption. * **Iops** *(integer) --* Input/output operations per second for the volume. * **Throughput** *(integer) --* Volume data transfer rate. * **VolumeSize** *(integer) --* Size of the EBS volume in gigabytes. * **NoDevice** *(string) --* Indicates device should not be mapped. * **VirtualName** *(string) --* Virtual device name for ephemeral storage. * **CapacityReservationSpecification** *(dict) --* Specifies capacity reservation preferences. * **CapacityReservationPreference** *(string) --* Preference for using capacity reservation. * **CapacityReservationTarget** *(dict) --* Specific capacity reservation target. * **CapacityReservationId** *(string) --* Unique identifier for the capacity reservation. * **CapacityReservationResourceGroupArn** *(string) --* ARN of the capacity reservation resource group. * **CpuOptions** *(dict) --* Configures CPU-specific settings. * **AmdSevSnp** *(string) --* AMD Secure Encrypted Virtualization configuration. * **CoreCount** *(integer) --* Number of CPU cores to allocate. * **ThreadsPerCore** *(integer) --* Number of threads per CPU core. * **CreditSpecification** *(dict) --* Defines CPU credit configuration for burstable instances. * **CpuCredits** *(string) --* CPU credit specification mode. * **DisableApiStop** *(boolean) --* Prevents API-initiated instance stop. * **EbsOptimized** *(boolean) --* Enables optimized EBS performance. * **EnablePrimaryIpv6** *(boolean) --* Enables primary IPv6 address configuration. * **EnclaveOptions** *(dict) --* Configures AWS Nitro Enclave settings. * **Enabled** *(boolean) --* Enables or disables AWS Nitro Enclaves for enhanced security. * **HibernationOptions** *(dict) --* Configures instance hibernation capabilities. * **Configured** *(boolean) --* Enables or disables instance hibernation capability. * **IamInstanceProfile** *(dict) --* Specifies IAM instance profile configuration. * **Arn** *(string) --* Amazon Resource Name (ARN) of the IAM instance profile. * **Name** *(string) --* Name of the IAM instance profile. * **ImageId** *(string) --* Identifies the Amazon Machine Image (AMI) for the instance. * **InstanceMarketOptions** *(dict) --* Configures marketplace-specific deployment options. * **MarketType** *(string) --* Specifies the type of marketplace for instance deployment. * **SpotOptions** *(dict) --* Configuration options for spot instance deployment. * **BlockDurationMinutes** *(integer) --* Duration of spot instance block reservation. * **InstanceInterruptionBehavior** *(string) --* Specifies behavior when spot instance is interrupted. * **MaxPrice** *(string) --* Maximum hourly price for spot instance. * **SpotInstanceType** *(string) --* Defines the type of spot instance request. * **ValidUntilUtc** *(datetime) --* Timestamp until which spot instance request is valid. * **InstanceType** *(string) --* Specifies the WorkSpace Instance type. * **Ipv6Addresses** *(list) --* Configures specific IPv6 addresses. * *(dict) --* Represents an IPv6 address configuration for a WorkSpace Instance. * **Ipv6Address** *(string) --* Specific IPv6 address assigned to the instance. * **IsPrimaryIpv6** *(boolean) --* Indicates if this is the primary IPv6 address for the instance. * **Ipv6AddressCount** *(integer) --* Specifies number of IPv6 addresses to assign. * **KernelId** *(string) --* Identifies the kernel for the instance. * **KeyName** *(string) --* Specifies the key pair for instance access. * **LicenseSpecifications** *(list) --* Configures license-related settings. * *(dict) --* Specifies license configuration for WorkSpace Instance. * **LicenseConfigurationArn** *(string) --* ARN of the license configuration for the WorkSpace Instance. * **MaintenanceOptions** *(dict) --* Defines automatic maintenance settings. * **AutoRecovery** *(string) --* Enables or disables automatic instance recovery. * **MetadataOptions** *(dict) --* Configures instance metadata service settings. * **HttpEndpoint** *(string) --* Enables or disables HTTP endpoint for instance metadata. * **HttpProtocolIpv6** *(string) --* Configures IPv6 support for instance metadata HTTP protocol. * **HttpPutResponseHopLimit** *(integer) --* Sets maximum number of network hops for metadata PUT responses. * **HttpTokens** *(string) --* Configures token requirement for instance metadata retrieval. * **InstanceMetadataTags** *(string) --* Enables or disables instance metadata tags retrieval. * **Monitoring** *(dict) --* Enables or disables detailed instance monitoring. * **Enabled** *(boolean) --* Enables or disables detailed instance monitoring. * **NetworkInterfaces** *(list) --* Configures network interface settings. * *(dict) --* Defines network interface configuration for WorkSpace Instance. * **AssociateCarrierIpAddress** *(boolean) --* Enables carrier IP address association. * **AssociatePublicIpAddress** *(boolean) --* Enables public IP address assignment. * **ConnectionTrackingSpecification** *(dict) --* Configures network connection tracking parameters. * **TcpEstablishedTimeout** *(integer) --* Timeout for established TCP connections. * **UdpStreamTimeout** *(integer) --* Timeout for UDP stream connections. * **UdpTimeout** *(integer) --* General timeout for UDP connections. * **Description** *(string) --* Descriptive text for the network interface. * **DeviceIndex** *(integer) --* Unique index for the network interface. * **EnaSrdSpecification** *(dict) --* Configures Elastic Network Adapter Scalable Reliable Datagram settings. * **EnaSrdEnabled** *(boolean) --* Enables or disables ENA SRD for network performance. * **EnaSrdUdpSpecification** *(dict) --* Configures UDP-specific ENA SRD settings. * **EnaSrdUdpEnabled** *(boolean) --* Enables or disables ENA SRD for UDP traffic. * **InterfaceType** *(string) --* Specifies the type of network interface. * **Ipv4Prefixes** *(list) --* IPv4 prefix configurations for the interface. * *(dict) --* Specifies IPv4 prefix configuration for network interfaces. * **Ipv4Prefix** *(string) --* Specific IPv4 prefix for network interface configuration. * **Ipv4PrefixCount** *(integer) --* Number of IPv4 prefixes to assign. * **Ipv6AddressCount** *(integer) --* Number of IPv6 addresses to assign. * **Ipv6Addresses** *(list) --* Specific IPv6 addresses for the interface. * *(dict) --* Represents an IPv6 address configuration for a WorkSpace Instance. * **Ipv6Address** *(string) --* Specific IPv6 address assigned to the instance. * **IsPrimaryIpv6** *(boolean) --* Indicates if this is the primary IPv6 address for the instance. * **Ipv6Prefixes** *(list) --* IPv6 prefix configurations for the interface. * *(dict) --* Specifies IPv6 prefix configuration for network interfaces. * **Ipv6Prefix** *(string) --* Specific IPv6 prefix for network interface configuration. * **Ipv6PrefixCount** *(integer) --* Number of IPv6 prefixes to assign. * **NetworkCardIndex** *(integer) --* Index of the network card for multiple network interfaces. * **NetworkInterfaceId** *(string) --* Unique identifier for the network interface. * **PrimaryIpv6** *(boolean) --* Indicates the primary IPv6 configuration. * **PrivateIpAddress** *(string) --* Primary private IP address for the interface. * **PrivateIpAddresses** *(list) --* List of private IP addresses for the interface. * *(dict) --* Defines private IP address configuration for network interface. * **Primary** *(boolean) --* Indicates if this is the primary private IP address. * **PrivateIpAddress** *(string) --* Specific private IP address for the network interface. * **SecondaryPrivateIpAddressCount** *(integer) --* Number of additional private IP addresses to assign. * **Groups** *(list) --* Security groups associated with the network interface. * *(string) --* * **SubnetId** *(string) --* Subnet identifier for the network interface. * **NetworkPerformanceOptions** *(dict) --* Defines network performance configuration. * **BandwidthWeighting** *(string) --* Defines bandwidth allocation strategy for network interfaces. * **Placement** *(dict) --* Specifies instance placement preferences. * **Affinity** *(string) --* Specifies host affinity for dedicated instances. * **AvailabilityZone** *(string) --* Identifies the specific AWS availability zone. * **GroupId** *(string) --* Unique identifier for placement group. * **GroupName** *(string) --* Name of the placement group. * **HostId** *(string) --* Identifies the specific dedicated host. * **HostResourceGroupArn** *(string) --* ARN of the host resource group. * **PartitionNumber** *(integer) --* Specifies partition number for partition placement groups. * **Tenancy** *(string) --* Defines instance tenancy configuration. * **PrivateDnsNameOptions** *(dict) --* Configures private DNS name settings. * **HostnameType** *(string) --* Specifies the type of hostname configuration. * **EnableResourceNameDnsARecord** *(boolean) --* Enables DNS A record for resource name resolution. * **EnableResourceNameDnsAAAARecord** *(boolean) --* Enables DNS AAAA record for resource name resolution. * **PrivateIpAddress** *(string) --* Specifies the primary private IP address. * **RamdiskId** *(string) --* Identifies the ramdisk for the instance. * **SecurityGroupIds** *(list) --* Specifies security group identifiers. * *(string) --* * **SecurityGroups** *(list) --* Configures security group settings. * *(string) --* * **SubnetId** *(string) --* Identifies the subnet for the instance. * **TagSpecifications** *(list) --* Configures resource tagging specifications. * *(dict) --* Defines tagging configuration for a resource. * **ResourceType** *(string) --* Type of resource being tagged. * **Tags** *(list) --* Collection of tags for the specified resource. * *(dict) --* Represents a key-value metadata tag. * **Key** *(string) --* Unique identifier for the tag. * **Value** *(string) --* Value associated with the tag key. * **UserData** *(string) --* Provides custom initialization data for the instance. Return type: dict Returns: **Response Syntax** { 'WorkspaceInstanceId': 'string' } **Response Structure** * *(dict) --* Returns the unique identifier for the newly created WorkSpaces Instance. * **WorkspaceInstanceId** *(string) --* Unique identifier assigned to the newly created WorkSpaces Instance. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" * "WorkspacesInstances.Client.exceptions.ServiceQuotaExceededExcep tion" * "WorkspacesInstances.Client.exceptions.ConflictException" WorkspacesInstances / Client / can_paginate can_paginate ************ WorkspacesInstances.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. WorkspacesInstances / Client / delete_workspace_instance delete_workspace_instance ************************* WorkspacesInstances.Client.delete_workspace_instance(**kwargs) Deletes the specified WorkSpace See also: AWS API Documentation **Request Syntax** response = client.delete_workspace_instance( WorkspaceInstanceId='string' ) Parameters: **WorkspaceInstanceId** (*string*) -- **[REQUIRED]** Unique identifier of the WorkSpaces Instance targeted for deletion. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Confirms the successful deletion of the specified WorkSpace Instance. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.InternalServerException" * "WorkspacesInstances.Client.exceptions.ConflictException" WorkspacesInstances / Client / list_tags_for_resource list_tags_for_resource ********************** WorkspacesInstances.Client.list_tags_for_resource(**kwargs) Retrieves tags for a WorkSpace Instance. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( WorkspaceInstanceId='string' ) Parameters: **WorkspaceInstanceId** (*string*) -- **[REQUIRED]** Unique identifier of the WorkSpace Instance. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* Returns the list of tags for the specified WorkSpace Instance. * **Tags** *(list) --* Collection of tags associated with the WorkSpace Instance. * *(dict) --* Represents a key-value metadata tag. * **Key** *(string) --* Unique identifier for the tag. * **Value** *(string) --* Value associated with the tag key. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" WorkspacesInstances / Client / untag_resource untag_resource ************** WorkspacesInstances.Client.untag_resource(**kwargs) Removes tags from a WorkSpace Instance. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( WorkspaceInstanceId='string', TagKeys=[ 'string', ] ) Parameters: * **WorkspaceInstanceId** (*string*) -- **[REQUIRED]** Unique identifier of the WorkSpace Instance to untag. * **TagKeys** (*list*) -- **[REQUIRED]** Keys of tags to be removed. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Confirms successful tag removal. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" WorkspacesInstances / Client / get_waiter get_waiter ********** WorkspacesInstances.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" WorkspacesInstances / Client / create_volume create_volume ************* WorkspacesInstances.Client.create_volume(**kwargs) Creates a new volume for WorkSpace Instances. See also: AWS API Documentation **Request Syntax** response = client.create_volume( AvailabilityZone='string', ClientToken='string', Encrypted=True|False, Iops=123, KmsKeyId='string', SizeInGB=123, SnapshotId='string', TagSpecifications=[ { 'ResourceType': 'instance'|'volume'|'spot-instances-request'|'network-interface', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], Throughput=123, VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' ) Parameters: * **AvailabilityZone** (*string*) -- **[REQUIRED]** Availability zone for the volume. * **ClientToken** (*string*) -- Unique token to prevent duplicate volume creation. This field is autopopulated if not provided. * **Encrypted** (*boolean*) -- Indicates if the volume should be encrypted. * **Iops** (*integer*) -- Input/output operations per second for the volume. * **KmsKeyId** (*string*) -- KMS key for volume encryption. * **SizeInGB** (*integer*) -- Volume size in gigabytes. * **SnapshotId** (*string*) -- Source snapshot for volume creation. * **TagSpecifications** (*list*) -- Metadata tags for the volume. * *(dict) --* Defines tagging configuration for a resource. * **ResourceType** *(string) --* Type of resource being tagged. * **Tags** *(list) --* Collection of tags for the specified resource. * *(dict) --* Represents a key-value metadata tag. * **Key** *(string) --* Unique identifier for the tag. * **Value** *(string) --* Value associated with the tag key. * **Throughput** (*integer*) -- Volume throughput performance. * **VolumeType** (*string*) -- Type of EBS volume. Return type: dict Returns: **Response Syntax** { 'VolumeId': 'string' } **Response Structure** * *(dict) --* Returns the created volume identifier. * **VolumeId** *(string) --* Unique identifier for the new volume. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" * "WorkspacesInstances.Client.exceptions.ServiceQuotaExceededExcep tion" * "WorkspacesInstances.Client.exceptions.ConflictException" WorkspacesInstances / Client / delete_volume delete_volume ************* WorkspacesInstances.Client.delete_volume(**kwargs) Deletes a specified volume. See also: AWS API Documentation **Request Syntax** response = client.delete_volume( VolumeId='string' ) Parameters: **VolumeId** (*string*) -- **[REQUIRED]** Identifier of the volume to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Confirms volume deletion. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.InternalServerException" * "WorkspacesInstances.Client.exceptions.ConflictException" WorkspacesInstances / Client / list_instance_types list_instance_types ******************* WorkspacesInstances.Client.list_instance_types(**kwargs) Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration. See also: AWS API Documentation **Request Syntax** response = client.list_instance_types( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- Maximum number of instance types to return in a single API call. Enables pagination of instance type results. * **NextToken** (*string*) -- Pagination token for retrieving subsequent pages of instance type results. Return type: dict Returns: **Response Syntax** { 'InstanceTypes': [ { 'InstanceType': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the list of instance types supported by WorkSpaces Instances. * **InstanceTypes** *(list) --* Collection of supported instance types for WorkSpaces Instances. * *(dict) --* Provides details about a specific WorkSpace Instance type. * **InstanceType** *(string) --* Unique identifier for the WorkSpace Instance type. * **NextToken** *(string) --* Token for retrieving additional instance types if the result set is paginated. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" WorkspacesInstances / Client / associate_volume associate_volume **************** WorkspacesInstances.Client.associate_volume(**kwargs) Attaches a volume to a WorkSpace Instance. See also: AWS API Documentation **Request Syntax** response = client.associate_volume( WorkspaceInstanceId='string', VolumeId='string', Device='string' ) Parameters: * **WorkspaceInstanceId** (*string*) -- **[REQUIRED]** WorkSpace Instance to attach volume to. * **VolumeId** (*string*) -- **[REQUIRED]** Volume to be attached. * **Device** (*string*) -- **[REQUIRED]** Device path for volume attachment. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Confirms volume attachment. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.InternalServerException" * "WorkspacesInstances.Client.exceptions.ConflictException" WorkspacesInstances / Client / close close ***** WorkspacesInstances.Client.close() Closes underlying endpoint connections. WorkspacesInstances / Client / list_regions list_regions ************ WorkspacesInstances.Client.list_regions(**kwargs) Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments. See also: AWS API Documentation **Request Syntax** response = client.list_regions( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- Maximum number of regions to return in a single API call. Enables pagination of region results. * **NextToken** (*string*) -- Pagination token for retrieving subsequent pages of region results. Return type: dict Returns: **Response Syntax** { 'Regions': [ { 'RegionName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the list of supported AWS regions for WorkSpaces Instances. * **Regions** *(list) --* Collection of AWS regions supported by WorkSpaces Instances. * *(dict) --* Represents an AWS region supported by WorkSpaces Instances. * **RegionName** *(string) --* Name of the AWS region. * **NextToken** *(string) --* Token for retrieving additional regions if the result set is paginated. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" WorkspacesInstances / Client / get_workspace_instance get_workspace_instance ********************** WorkspacesInstances.Client.get_workspace_instance(**kwargs) Retrieves detailed information about a specific WorkSpace Instance. See also: AWS API Documentation **Request Syntax** response = client.get_workspace_instance( WorkspaceInstanceId='string' ) Parameters: **WorkspaceInstanceId** (*string*) -- **[REQUIRED]** Unique identifier of the WorkSpace Instance to retrieve. Return type: dict Returns: **Response Syntax** { 'WorkspaceInstanceErrors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ], 'EC2InstanceErrors': [ { 'EC2ErrorCode': 'string', 'EC2ExceptionType': 'string', 'EC2ErrorMessage': 'string' }, ], 'ProvisionState': 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING', 'WorkspaceInstanceId': 'string', 'EC2ManagedInstance': { 'InstanceId': 'string' } } **Response Structure** * *(dict) --* Provides comprehensive details about the requested WorkSpaces Instance. * **WorkspaceInstanceErrors** *(list) --* Captures any errors specific to the WorkSpace Instance lifecycle. * *(dict) --* Captures errors specific to WorkSpace Instance operations. * **ErrorCode** *(string) --* Unique error code for the WorkSpace Instance error. * **ErrorMessage** *(string) --* Detailed description of the WorkSpace Instance error. * **EC2InstanceErrors** *(list) --* Includes any underlying EC2 instance errors encountered. * *(dict) --* Captures detailed error information for EC2 instance operations. * **EC2ErrorCode** *(string) --* Unique error code identifying the specific EC2 instance error. * **EC2ExceptionType** *(string) --* Type of exception encountered during EC2 instance operation. * **EC2ErrorMessage** *(string) --* Detailed description of the EC2 instance error. * **ProvisionState** *(string) --* Current provisioning state of the WorkSpaces Instance. * **WorkspaceInstanceId** *(string) --* Unique identifier of the retrieved WorkSpaces Instance. * **EC2ManagedInstance** *(dict) --* Details of the associated EC2 managed instance. * **InstanceId** *(string) --* Unique identifier of the managed EC2 instance. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.InternalServerException" WorkspacesInstances / Client / tag_resource tag_resource ************ WorkspacesInstances.Client.tag_resource(**kwargs) Adds tags to a WorkSpace Instance. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( WorkspaceInstanceId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **WorkspaceInstanceId** (*string*) -- **[REQUIRED]** Unique identifier of the WorkSpace Instance to tag. * **Tags** (*list*) -- **[REQUIRED]** Tags to be added to the WorkSpace Instance. * *(dict) --* Represents a key-value metadata tag. * **Key** *(string) --* Unique identifier for the tag. * **Value** *(string) --* Value associated with the tag key. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Confirms successful tag addition. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.InternalServerException" WorkspacesInstances / Client / disassociate_volume disassociate_volume ******************* WorkspacesInstances.Client.disassociate_volume(**kwargs) Detaches a volume from a WorkSpace Instance. See also: AWS API Documentation **Request Syntax** response = client.disassociate_volume( WorkspaceInstanceId='string', VolumeId='string', Device='string', DisassociateMode='FORCE'|'NO_FORCE' ) Parameters: * **WorkspaceInstanceId** (*string*) -- **[REQUIRED]** WorkSpace Instance to detach volume from. * **VolumeId** (*string*) -- **[REQUIRED]** Volume to be detached. * **Device** (*string*) -- Device path of volume to detach. * **DisassociateMode** (*string*) -- Mode for volume detachment. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Confirms volume detachment. **Exceptions** * "WorkspacesInstances.Client.exceptions.ValidationException" * "WorkspacesInstances.Client.exceptions.AccessDeniedException" * "WorkspacesInstances.Client.exceptions.ThrottlingException" * "WorkspacesInstances.Client.exceptions.ResourceNotFoundException" * "WorkspacesInstances.Client.exceptions.InternalServerException" * "WorkspacesInstances.Client.exceptions.ConflictException"