Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkSpaces.DescribeWorkspaces

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified WorkSpaces.

You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

This operation returns paginated results.

Synopsis

data DescribeWorkspaces = DescribeWorkspaces' {
- bundleId :: Maybe Text
- directoryId :: Maybe Text
- limit :: Maybe Natural
- nextToken :: Maybe Text
- userName :: Maybe Text
- workspaceIds :: Maybe (NonEmpty Text)
}
newDescribeWorkspaces :: DescribeWorkspaces
describeWorkspaces_bundleId :: Lens' DescribeWorkspaces (Maybe Text)
describeWorkspaces_directoryId :: Lens' DescribeWorkspaces (Maybe Text)
describeWorkspaces_limit :: Lens' DescribeWorkspaces (Maybe Natural)
describeWorkspaces_nextToken :: Lens' DescribeWorkspaces (Maybe Text)
describeWorkspaces_userName :: Lens' DescribeWorkspaces (Maybe Text)
describeWorkspaces_workspaceIds :: Lens' DescribeWorkspaces (Maybe (NonEmpty Text))
data DescribeWorkspacesResponse = DescribeWorkspacesResponse' {
- nextToken :: Maybe Text
- workspaces :: Maybe [Workspace]
- httpStatus :: Int
}
newDescribeWorkspacesResponse :: Int -> DescribeWorkspacesResponse
describeWorkspacesResponse_nextToken :: Lens' DescribeWorkspacesResponse (Maybe Text)
describeWorkspacesResponse_workspaces :: Lens' DescribeWorkspacesResponse (Maybe [Workspace])
describeWorkspacesResponse_httpStatus :: Lens' DescribeWorkspacesResponse Int

Creating a Request

data DescribeWorkspaces Source #

See: newDescribeWorkspaces smart constructor.

Constructors

DescribeWorkspaces'

Fields

bundleId :: Maybe Text
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 :: Maybe Text
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 :: Maybe Natural
The maximum number of items to return.
nextToken :: Maybe Text
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
userName :: Maybe Text
The name of the directory user. You must specify this parameter with DirectoryId.
workspaceIds :: Maybe (NonEmpty Text)
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.

Instances

Instances details

ToJSON DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods toJSON :: DescribeWorkspaces -> Value # toEncoding :: DescribeWorkspaces -> Encoding # toJSONList :: [DescribeWorkspaces] -> Value # toEncodingList :: [DescribeWorkspaces] -> Encoding #
ToHeaders DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods toHeaders :: DescribeWorkspaces -> [Header] #
ToPath DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods toPath :: DescribeWorkspaces -> ByteString #
ToQuery DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods toQuery :: DescribeWorkspaces -> QueryString #
AWSPager DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods page :: DescribeWorkspaces -> AWSResponse DescribeWorkspaces -> Maybe DescribeWorkspaces #
AWSRequest DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Associated Types type AWSResponse DescribeWorkspaces # Methods request :: (Service -> Service) -> DescribeWorkspaces -> Request DescribeWorkspaces # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeWorkspaces -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeWorkspaces))) #
Generic DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Associated Types type Rep DescribeWorkspaces :: Type -> Type # Methods from :: DescribeWorkspaces -> Rep DescribeWorkspaces x # to :: Rep DescribeWorkspaces x -> DescribeWorkspaces #
Read DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods readsPrec :: Int -> ReadS DescribeWorkspaces # readList :: ReadS [DescribeWorkspaces] # readPrec :: ReadPrec DescribeWorkspaces # readListPrec :: ReadPrec [DescribeWorkspaces] #
Show DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods showsPrec :: Int -> DescribeWorkspaces -> ShowS # show :: DescribeWorkspaces -> String # showList :: [DescribeWorkspaces] -> ShowS #
NFData DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods rnf :: DescribeWorkspaces -> () #
Eq DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods (==) :: DescribeWorkspaces -> DescribeWorkspaces -> Bool # (/=) :: DescribeWorkspaces -> DescribeWorkspaces -> Bool #
Hashable DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods hashWithSalt :: Int -> DescribeWorkspaces -> Int # hash :: DescribeWorkspaces -> Int #
type AWSResponse DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces type AWSResponse DescribeWorkspaces = DescribeWorkspacesResponse
type Rep DescribeWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces type Rep DescribeWorkspaces = D1 ('MetaData "DescribeWorkspaces" "Amazonka.WorkSpaces.DescribeWorkspaces" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeWorkspaces'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workspaceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))))

newDescribeWorkspaces :: DescribeWorkspaces Source #

Create a value of DescribeWorkspaces with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

DescribeWorkspaces, describeWorkspaces_directoryId - 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.

$sel:limit:DescribeWorkspaces', describeWorkspaces_limit - The maximum number of items to return.

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

DescribeWorkspaces, describeWorkspaces_userName - The name of the directory user. You must specify this parameter with DirectoryId.

$sel:workspaceIds:DescribeWorkspaces', describeWorkspaces_workspaceIds - 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.

Request Lenses

describeWorkspaces_bundleId :: Lens' DescribeWorkspaces (Maybe Text) Source #

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

describeWorkspaces_directoryId :: Lens' DescribeWorkspaces (Maybe Text) Source #

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.

describeWorkspaces_limit :: Lens' DescribeWorkspaces (Maybe Natural) Source #

The maximum number of items to return.

describeWorkspaces_nextToken :: Lens' DescribeWorkspaces (Maybe Text) Source #

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

describeWorkspaces_userName :: Lens' DescribeWorkspaces (Maybe Text) Source #

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

describeWorkspaces_workspaceIds :: Lens' DescribeWorkspaces (Maybe (NonEmpty Text)) Source #

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.

Destructuring the Response

data DescribeWorkspacesResponse Source #

See: newDescribeWorkspacesResponse smart constructor.

Constructors

DescribeWorkspacesResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is null when there are no more results to return. workspaces :: Maybe [Workspace] Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Associated Types type Rep DescribeWorkspacesResponse :: Type -> Type # Methods from :: DescribeWorkspacesResponse -> Rep DescribeWorkspacesResponse x # to :: Rep DescribeWorkspacesResponse x -> DescribeWorkspacesResponse #
Read DescribeWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods readsPrec :: Int -> ReadS DescribeWorkspacesResponse # readList :: ReadS [DescribeWorkspacesResponse] # readPrec :: ReadPrec DescribeWorkspacesResponse # readListPrec :: ReadPrec [DescribeWorkspacesResponse] #
Show DescribeWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods showsPrec :: Int -> DescribeWorkspacesResponse -> ShowS # show :: DescribeWorkspacesResponse -> String # showList :: [DescribeWorkspacesResponse] -> ShowS #
NFData DescribeWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods rnf :: DescribeWorkspacesResponse -> () #
Eq DescribeWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces Methods (==) :: DescribeWorkspacesResponse -> DescribeWorkspacesResponse -> Bool # (/=) :: DescribeWorkspacesResponse -> DescribeWorkspacesResponse -> Bool #
type Rep DescribeWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeWorkspaces type Rep DescribeWorkspacesResponse = D1 ('MetaData "DescribeWorkspacesResponse" "Amazonka.WorkSpaces.DescribeWorkspaces" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeWorkspacesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "workspaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Workspace])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeWorkspacesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeWorkspacesResponse'`
-> DescribeWorkspacesResponse

Create a value of DescribeWorkspacesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeWorkspaces, describeWorkspacesResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:workspaces:DescribeWorkspacesResponse', describeWorkspacesResponse_workspaces - Information about the WorkSpaces.

Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

$sel:httpStatus:DescribeWorkspacesResponse', describeWorkspacesResponse_httpStatus - The response's http status code.

Response Lenses

describeWorkspacesResponse_nextToken :: Lens' DescribeWorkspacesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeWorkspacesResponse_workspaces :: Lens' DescribeWorkspacesResponse (Maybe [Workspace]) Source #

Information about the WorkSpaces.

Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

describeWorkspacesResponse_httpStatus :: Lens' DescribeWorkspacesResponse Int Source #

The response's http status code.