Amazonka.IotTwinMaker.ListWorkspaces

Retrieves information about workspaces in the current account.

Creating a Request

data ListWorkspaces

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

ToJSON ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

toJSON :: ListWorkspaces -> Value

toEncoding :: ListWorkspaces -> Encoding

toJSONList :: [ListWorkspaces] -> Value

toEncodingList :: [ListWorkspaces] -> Encoding

ToHeaders ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

toHeaders :: ListWorkspaces -> [Header]

ToPath ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

toPath :: ListWorkspaces -> ByteString

ToQuery ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

toQuery :: ListWorkspaces -> QueryString

AWSRequest ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Associated Types

type AWSResponse ListWorkspaces

Methods

request :: (Service -> Service) -> ListWorkspaces -> Request ListWorkspaces

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListWorkspaces -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorkspaces)))

Generic ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Associated Types

type Rep ListWorkspaces :: Type -> Type

Methods

from :: ListWorkspaces -> Rep ListWorkspaces x

to :: Rep ListWorkspaces x -> ListWorkspaces

Read ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

readsPrec :: Int -> ReadS ListWorkspaces

readList :: ReadS [ListWorkspaces]

readPrec :: ReadPrec ListWorkspaces

readListPrec :: ReadPrec [ListWorkspaces]

Show ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

showsPrec :: Int -> ListWorkspaces -> ShowS

show :: ListWorkspaces -> String

showList :: [ListWorkspaces] -> ShowS

NFData ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

rnf :: ListWorkspaces -> ()

Eq ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

(==) :: ListWorkspaces -> ListWorkspaces -> Bool

(/=) :: ListWorkspaces -> ListWorkspaces -> Bool

Hashable ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

hashWithSalt :: Int -> ListWorkspaces -> Int

hash :: ListWorkspaces -> Int

type AWSResponse ListWorkspaces

Defined in Amazonka.IotTwinMaker.ListWorkspaces

type AWSResponse ListWorkspaces = ListWorkspacesResponse

type Rep ListWorkspaces

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

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)

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)

The string that specifies the next page of results.

Destructuring the Response

data ListWorkspacesResponse

See: newListWorkspacesResponse smart constructor.

Constructors

ListWorkspacesResponse'

Fields

• nextToken :: Maybe Text

  The string that specifies the next page of results.

• workspaceSummaries :: Maybe [WorkspaceSummary]

  A list of objects that contain information about the workspaces.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListWorkspacesResponse

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Associated Types

type Rep ListWorkspacesResponse :: Type -> Type

Methods

from :: ListWorkspacesResponse -> Rep ListWorkspacesResponse x

to :: Rep ListWorkspacesResponse x -> ListWorkspacesResponse

Read ListWorkspacesResponse

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

readsPrec :: Int -> ReadS ListWorkspacesResponse

readList :: ReadS [ListWorkspacesResponse]

readPrec :: ReadPrec ListWorkspacesResponse

readListPrec :: ReadPrec [ListWorkspacesResponse]

Show ListWorkspacesResponse

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

showsPrec :: Int -> ListWorkspacesResponse -> ShowS

show :: ListWorkspacesResponse -> String

showList :: [ListWorkspacesResponse] -> ShowS

NFData ListWorkspacesResponse

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

rnf :: ListWorkspacesResponse -> ()

Eq ListWorkspacesResponse

Defined in Amazonka.IotTwinMaker.ListWorkspaces

Methods

(==) :: ListWorkspacesResponse -> ListWorkspacesResponse -> Bool

(/=) :: ListWorkspacesResponse -> ListWorkspacesResponse -> Bool

type Rep ListWorkspacesResponse

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

Arguments

:: Int

$sel:httpStatus:ListWorkspacesResponse'

-> ListWorkspacesResponse

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)

The string that specifies the next page of results.

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

A list of objects that contain information about the workspaces.

listWorkspacesResponse_httpStatus :: Lens' ListWorkspacesResponse Int

The response's http status code.