libZSservicesZSamazonka-workspacesZSamazonka-workspaces
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkSpaces.DescribeWorkspaces

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

Creating a Request

data DescribeWorkspaces Source #

See: newDescribeWorkspaces smart constructor.

Constructors

DescribeWorkspaces' 

Fields

  • 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.

  • 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.

  • userName :: Maybe Text

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

  • 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.

  • 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.

  • limit :: Maybe Natural

    The maximum number of items to return.

Instances

Instances details
Eq DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Read DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Show DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Generic DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Associated Types

type Rep DescribeWorkspaces :: Type -> Type #

NFData DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Methods

rnf :: DescribeWorkspaces -> () #

Hashable DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

ToJSON DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

AWSPager DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

AWSRequest DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Associated Types

type AWSResponse DescribeWorkspaces #

ToHeaders DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

ToPath DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

ToQuery DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

type Rep DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

type Rep DescribeWorkspaces = D1 ('MetaData "DescribeWorkspaces" "Amazonka.WorkSpaces.DescribeWorkspaces" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" 'False) (C1 ('MetaCons "DescribeWorkspaces'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "workspaceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse DescribeWorkspaces Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

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:

$sel:directoryId: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: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.

$sel:userName:DescribeWorkspaces', describeWorkspaces_userName - The name of the directory user. You must specify this parameter with DirectoryId.

$sel:bundleId: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.

$sel:nextToken: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.

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

Request Lenses

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_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.

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

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

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_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_limit :: Lens' DescribeWorkspaces (Maybe Natural) Source #

The maximum number of items to return.

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
Eq DescribeWorkspacesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Read DescribeWorkspacesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Show DescribeWorkspacesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Generic DescribeWorkspacesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

Associated Types

type Rep DescribeWorkspacesResponse :: Type -> Type #

NFData DescribeWorkspacesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

type Rep DescribeWorkspacesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaces

type Rep DescribeWorkspacesResponse = D1 ('MetaData "DescribeWorkspacesResponse" "Amazonka.WorkSpaces.DescribeWorkspaces" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" '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 #

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:

$sel:nextToken: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.