"documentation":"<p>Associates the specified IP access control group with the specified directory.</p>"
},
"AuthorizeIpRules":{
"name":"AuthorizeIpRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AuthorizeIpRulesRequest"},
"output":{"shape":"AuthorizeIpRulesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Adds one or more rules to the specified IP access control group.</p> <p>This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.</p>"
},
"CreateIpGroup":{
"name":"CreateIpGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateIpGroupRequest"},
"output":{"shape":"CreateIpGroupResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceCreationFailedException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates an IP access control group.</p> <p>An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.</p> <p>There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.</p>"
"documentation":"<p>Deletes the specified IP access control group.</p> <p>You cannot delete an IP access control group that is associated with a directory.</p>"
"documentation":"<p>Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image. </p>"
},
"DescribeAccount":{
"name":"DescribeAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAccountRequest"},
"output":{"shape":"DescribeAccountResult"},
"errors":[
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.</p>"
"documentation":"<p>Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.</p>"
"documentation":"<p>Retrieves a list that describes the available WorkSpace bundles.</p> <p>You can filter the results using either bundle ID or owner, but not both.</p>"
"documentation":"<p>Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. </p>"
"documentation":"<p>Describes the specified WorkSpaces.</p> <p>You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.</p>"
"documentation":"<p>Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image. </p>"
"documentation":"<p>Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL). </p> <p>The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>"
},
"ModifyAccount":{
"name":"ModifyAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyAccountRequest"},
"output":{"shape":"ModifyAccountResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidResourceStateException"},
{"shape":"ResourceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Modifies the configuration of bring your own license (BYOL) for the specified account.</p>"
"documentation":"<p>Sets the state of the specified WorkSpace.</p> <p>To maintain a WorkSpace without being interrupted, set the WorkSpace state to <code>ADMIN_MAINTENANCE</code>. WorkSpaces in this state do not respond to requests to reboot, stop, start, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can log into a WorkSpace in the <code>ADMIN_MAINTENANCE</code> state.</p>"
"documentation":"<p>Reboots the specified WorkSpaces.</p> <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or <code>UNHEALTHY</code>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>"
"documentation":"<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, or <code>UNHEALTHY</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"http://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html\">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>"
},
"RevokeIpRules":{
"name":"RevokeIpRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RevokeIpRulesRequest"},
"output":{"shape":"RevokeIpRulesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Removes one or more rules from the specified IP access control group.</p>"
"documentation":"<p>Starts the specified WorkSpaces.</p> <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>STOPPED</code>.</p>"
"documentation":"<p> Stops the specified WorkSpaces.</p> <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>AVAILABLE</code>, <code>IMPAIRED</code>, <code>UNHEALTHY</code>, or <code>ERROR</code>.</p>"
"documentation":"<p>Terminates the specified WorkSpaces.</p> <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.</p> <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely terminated.</p>"
"documentation":"<p>Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials. </p>"
}
},
"documentation":"<p>Describes an Amazon WorkSpaces client.</p>"
},
"ClientPropertiesList":{
"type":"list",
"member":{"shape":"ClientPropertiesResult"}
},
"ClientPropertiesResult":{
"type":"structure",
"members":{
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource identifier, in the form of a directory ID.</p>"
},
"ClientProperties":{
"shape":"ClientProperties",
"documentation":"<p>Information about the Amazon WorkSpaces client.</p>"
}
},
"documentation":"<p>Information about the Amazon WorkSpaces client.</p>"
"documentation":"<p>Information about the WorkSpaces that were created.</p> <p>Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call <a>DescribeWorkspaces</a> before the WorkSpace is created, the information returned can be incomplete.</p>"
"documentation":"<p>The identifier of the image.</p>"
}
}
},
"DeleteWorkspaceImageResult":{
"type":"structure",
"members":{
}
},
"DescribeAccountModificationsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>"
}
}
},
"DescribeAccountModificationsResult":{
"type":"structure",
"members":{
"AccountModifications":{
"shape":"AccountModificationList",
"documentation":"<p>The list of modifications to the configuration of BYOL.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
}
}
},
"DescribeAccountRequest":{
"type":"structure",
"members":{
}
},
"DescribeAccountResult":{
"type":"structure",
"members":{
"DedicatedTenancySupport":{
"shape":"DedicatedTenancySupportResultEnum",
"documentation":"<p>The status of BYOL (whether BYOL is enabled or disabled).</p>"
},
"DedicatedTenancyManagementCidrRange":{
"shape":"DedicatedTenancyManagementCidrRange",
"documentation":"<p>The IP address range, specified as an IPv4 CIDR block, used for the management network interface.</p> <p>The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>"
}
}
},
"DescribeClientPropertiesRequest":{
"type":"structure",
"required":["ResourceIds"],
"members":{
"ResourceIds":{
"shape":"ResourceIdList",
"documentation":"<p>The resource identifiers, in the form of directory IDs.</p>"
}
}
},
"DescribeClientPropertiesResult":{
"type":"structure",
"members":{
"ClientPropertiesList":{
"shape":"ClientPropertiesList",
"documentation":"<p>Information about the specified Amazon WorkSpaces clients.</p>"
"documentation":"<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>"
"documentation":"<p>The owner of the bundles. You cannot combine this parameter with any other filter.</p> <p>Specify <code>AMAZON</code> to describe the bundles provided by AWS or null to describe the bundles that belong to your account.</p>"
"documentation":"<p>The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.</p>"
"documentation":"<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>"
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
}
}
},
"DescribeWorkspaceImagesRequest":{
"type":"structure",
"members":{
"ImageIds":{
"shape":"WorkspaceImageIdList",
"documentation":"<p>The identifier of the image.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>"
},
"MaxResults":{
"shape":"Limit",
"documentation":"<p>The maximum number of items to return.</p>"
}
}
},
"DescribeWorkspaceImagesResult":{
"type":"structure",
"members":{
"Images":{
"shape":"WorkspaceImageList",
"documentation":"<p>Information about the images.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
"documentation":"<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>"
"documentation":"<p>The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.</p> <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned.</p>"
"documentation":"<p>The identifier of the directory. In addition, you can optionally specify a specific directory user (see <code>UserName</code>). You cannot combine this parameter with any other filter.</p>"
"documentation":"<p>The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.</p>"
"documentation":"<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>"
"documentation":"<p>Information about the WorkSpaces.</p> <p>Because <a>CreateWorkspaces</a> is an asynchronous operation, some of the returned information could be incomplete.</p>"
"documentation":"<p>Describes a WorkSpace that could not be rebooted. (<a>RebootWorkspaces</a>), rebuilt (<a>RebuildWorkspaces</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>"
},
"ImportWorkspaceImageRequest":{
"type":"structure",
"required":[
"Ec2ImageId",
"IngestionProcess",
"ImageName",
"ImageDescription"
],
"members":{
"Ec2ImageId":{
"shape":"Ec2ImageId",
"documentation":"<p>The identifier of the EC2 image.</p>"
},
"IngestionProcess":{
"shape":"WorkspaceImageIngestionProcess",
"documentation":"<p>The ingestion process to be used when importing the image.</p>"
},
"ImageName":{
"shape":"WorkspaceImageName",
"documentation":"<p>The name of the WorkSpace image.</p>"
},
"ImageDescription":{
"shape":"WorkspaceImageDescription",
"documentation":"<p>The description of the WorkSpace image.</p>"
}
}
},
"ImportWorkspaceImageResult":{
"type":"structure",
"members":{
"ImageId":{
"shape":"WorkspaceImageId",
"documentation":"<p>The identifier of the WorkSpace image.</p>"
"documentation":"<p>The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).</p>"
},
"MaxResults":{
"shape":"ManagementCidrRangeMaxResults",
"documentation":"<p>The maximum number of items to return.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>"
}
}
},
"ListAvailableManagementCidrRangesResult":{
"type":"structure",
"members":{
"ManagementCidrRanges":{
"shape":"DedicatedTenancyCidrRangeList",
"documentation":"<p>The list of available IP address ranges, specified as IPv4 CIDR blocks.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
"documentation":"<p>The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the <code>ListAvailableManagementCidrRanges</code> operation.</p>"
"documentation":"<p>The configuration of this WorkSpace is not supported for this operation. For more information, see the <a href=\"http://docs.aws.amazon.com/workspaces/latest/adminguide/\">Amazon WorkSpaces Administration Guide</a>. </p>",
"documentation":"<p>The owner of the bundle. This is the account identifier of the owner, or <code>AMAZON</code> if the bundle is provided by AWS.</p>"
"documentation":"<p>The compute type. For more information, see <a href=\"http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles\">Amazon WorkSpaces Bundles</a>.</p>"
"documentation":"<p>The name of the directory.</p>"
},
"RegistrationCode":{
"shape":"RegistrationCode",
"documentation":"<p>The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.</p>"
"documentation":"<p>The user name for the service account.</p>"
},
"IamRoleId":{
"shape":"ARN",
"documentation":"<p>The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.</p>"
},
"DirectoryType":{
"shape":"WorkspaceDirectoryType",
"documentation":"<p>The directory type.</p>"
},
"WorkspaceSecurityGroupId":{
"shape":"SecurityGroupId",
"documentation":"<p>The identifier of the security group that is assigned to new WorkSpaces.</p>"
},
"State":{
"shape":"WorkspaceDirectoryState",
"documentation":"<p>The state of the directory's registration with Amazon WorkSpaces</p>"
"documentation":"<p>The identifier of the image.</p>"
},
"Name":{
"shape":"WorkspaceImageName",
"documentation":"<p>The name of the image.</p>"
},
"Description":{
"shape":"WorkspaceImageDescription",
"documentation":"<p>The description of the image.</p>"
},
"OperatingSystem":{
"shape":"OperatingSystem",
"documentation":"<p>The operating system that the image is running. </p>"
},
"State":{
"shape":"WorkspaceImageState",
"documentation":"<p>The status of the image.</p>"
},
"RequiredTenancy":{
"shape":"WorkspaceImageRequiredTenancy",
"documentation":"<p>Specifies whether the image is running on dedicated hardware. When bring your own license (BYOL) is enabled, this value is set to DEDICATED. </p>"
},
"ErrorCode":{
"shape":"WorkspaceImageErrorCode",
"documentation":"<p>The error code that is returned for the image.</p>"
},
"ErrorMessage":{
"shape":"Description",
"documentation":"<p>The text of the error message that is returned for the image.</p>"
}
},
"documentation":"<p>Describes a WorkSpace image.</p>"
"documentation":"<p>The running mode. For more information, see <a href=\"http://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html\">Manage the WorkSpace Running Mode</a>.</p>"
"documentation":"<p>The size of the root volume.</p>"
},
"UserVolumeSizeGib":{
"shape":"UserVolumeSizeGib",
"documentation":"<p>The size of the user storage.</p>"
},
"ComputeTypeName":{
"shape":"Compute",
"documentation":"<p>The compute type. For more information, see <a href=\"http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles\">Amazon WorkSpaces Bundles</a>.</p>"
"documentation":"<p>The identifier of the AWS Directory Service directory for the WorkSpace. You can use <a>DescribeWorkspaceDirectories</a> to list the available directories.</p>"
"documentation":"<p>The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.</p>"
"documentation":"<fullname>Amazon WorkSpaces Service</fullname> <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.</p>"