amazonka-iottwinmaker-2.0: Amazon IoT TwinMaker SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IotTwinMaker.ListWorkspaces

Description

Retrieves information about workspaces in the current account.

Synopsis

Creating a Request

data ListWorkspaces Source #

See: newListWorkspaces smart constructor.

Constructors

ListWorkspaces' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

  • nextToken :: Maybe Text

    The string that specifies the next page of results.

Instances

Instances details
ToJSON ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

ToHeaders ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

ToPath ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

ToQuery ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

AWSRequest ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Associated Types

type AWSResponse ListWorkspaces #

Generic ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Associated Types

type Rep ListWorkspaces :: Type -> Type #

Read ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Show ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

NFData ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

rnf :: ListWorkspaces -> () #

Eq ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Hashable ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

type AWSResponse ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

type Rep ListWorkspaces Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

type Rep ListWorkspaces = D1 ('MetaData "ListWorkspaces" "Amazonka.IotTwinMaker.ListWorkspaces" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "ListWorkspaces'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListWorkspaces :: ListWorkspaces Source #

Create a value of ListWorkspaces 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:maxResults:ListWorkspaces', listWorkspaces_maxResults - The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

ListWorkspaces, listWorkspaces_nextToken - The string that specifies the next page of results.

Request Lenses

listWorkspaces_maxResults :: Lens' ListWorkspaces (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

listWorkspaces_nextToken :: Lens' ListWorkspaces (Maybe Text) Source #

The string that specifies the next page of results.

Destructuring the Response

data ListWorkspacesResponse Source #

See: newListWorkspacesResponse smart constructor.

Constructors

ListWorkspacesResponse' 

Fields

Instances

Instances details
Generic ListWorkspacesResponse Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Associated Types

type Rep ListWorkspacesResponse :: Type -> Type #

Read ListWorkspacesResponse Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Show ListWorkspacesResponse Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

NFData ListWorkspacesResponse Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

rnf :: ListWorkspacesResponse -> () #

Eq ListWorkspacesResponse Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

type Rep ListWorkspacesResponse Source # 
Instance details

Defined in Amazonka.IotTwinMaker.ListWorkspaces

type Rep ListWorkspacesResponse = D1 ('MetaData "ListWorkspacesResponse" "Amazonka.IotTwinMaker.ListWorkspaces" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "ListWorkspacesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "workspaceSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkspaceSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListWorkspacesResponse Source #

Create a value of ListWorkspacesResponse 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:

ListWorkspaces, listWorkspacesResponse_nextToken - The string that specifies the next page of results.

$sel:workspaceSummaries:ListWorkspacesResponse', listWorkspacesResponse_workspaceSummaries - A list of objects that contain information about the workspaces.

$sel:httpStatus:ListWorkspacesResponse', listWorkspacesResponse_httpStatus - The response's http status code.

Response Lenses

listWorkspacesResponse_nextToken :: Lens' ListWorkspacesResponse (Maybe Text) Source #

The string that specifies the next page of results.

listWorkspacesResponse_workspaceSummaries :: Lens' ListWorkspacesResponse (Maybe [WorkspaceSummary]) Source #

A list of objects that contain information about the workspaces.