AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeWorkspacesInput

import "github.com/aws/aws-sdk-go/service/workspaces"

type DescribeWorkspacesInput struct { BundleId *string `type:"string"` DirectoryId *string `type:"string"` Limit *int64 `min:"1" type:"integer"` NextToken *string `min:"1" type:"string"` UserName *string `min:"1" type:"string"` WorkspaceIds []*string `min:"1" type:"list"` }

BundleId

Type: *string

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

DirectoryId

Type: *string

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

Limit

Type: *int64

The maximum number of items to return.

NextToken

Type: *string

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

UserName

Type: *string

The name of the directory user. You must specify this parameter with DirectoryId.

WorkspaceIds

Type: []*string

The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

Method

GoString

func (s DescribeWorkspacesInput) GoString() string

GoString returns the string representation

SetBundleId

func (s *DescribeWorkspacesInput) SetBundleId(v string) *DescribeWorkspacesInput

SetBundleId sets the BundleId field's value.

SetDirectoryId

func (s *DescribeWorkspacesInput) SetDirectoryId(v string) *DescribeWorkspacesInput

SetDirectoryId sets the DirectoryId field's value.

SetLimit

func (s *DescribeWorkspacesInput) SetLimit(v int64) *DescribeWorkspacesInput

SetLimit sets the Limit field's value.

SetNextToken

func (s *DescribeWorkspacesInput) SetNextToken(v string) *DescribeWorkspacesInput

SetNextToken sets the NextToken field's value.

SetUserName

func (s *DescribeWorkspacesInput) SetUserName(v string) *DescribeWorkspacesInput

SetUserName sets the UserName field's value.

SetWorkspaceIds

func (s *DescribeWorkspacesInput) SetWorkspaceIds(v []*string) *DescribeWorkspacesInput

SetWorkspaceIds sets the WorkspaceIds field's value.

String

func (s DescribeWorkspacesInput) String() string

String returns the string representation

Validate

func (s *DescribeWorkspacesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: