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.AMP.ListWorkspaces

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all AMP workspaces, including workspaces being created or deleted.

This operation returns paginated results.

Creating a Request

data ListWorkspaces Source #

Represents the input of a ListWorkspaces operation.

See: newListWorkspaces smart constructor.

Constructors

ListWorkspaces'

Fields

alias :: Maybe Text
Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
maxResults :: Maybe Natural
Maximum results to return in response (default=100, maximum=1000).
nextToken :: Maybe Text
Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

Instances

Instances details

ToHeaders ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods toHeaders :: ListWorkspaces -> [Header] #
ToPath ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods toPath :: ListWorkspaces -> ByteString #
ToQuery ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods toQuery :: ListWorkspaces -> QueryString #
AWSPager ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods page :: ListWorkspaces -> AWSResponse ListWorkspaces -> Maybe ListWorkspaces #
AWSRequest ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.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 Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Associated Types type Rep ListWorkspaces :: Type -> Type # Methods from :: ListWorkspaces -> Rep ListWorkspaces x # to :: Rep ListWorkspaces x -> ListWorkspaces #
Read ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods readsPrec :: Int -> ReadS ListWorkspaces # readList :: ReadS [ListWorkspaces] # readPrec :: ReadPrec ListWorkspaces # readListPrec :: ReadPrec [ListWorkspaces] #
Show ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods showsPrec :: Int -> ListWorkspaces -> ShowS # show :: ListWorkspaces -> String # showList :: [ListWorkspaces] -> ShowS #
NFData ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods rnf :: ListWorkspaces -> () #
Eq ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods (==) :: ListWorkspaces -> ListWorkspaces -> Bool # (/=) :: ListWorkspaces -> ListWorkspaces -> Bool #
Hashable ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces Methods hashWithSalt :: Int -> ListWorkspaces -> Int # hash :: ListWorkspaces -> Int #
type AWSResponse ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces type AWSResponse ListWorkspaces = ListWorkspacesResponse
type Rep ListWorkspaces Source #
Instance details Defined in Amazonka.AMP.ListWorkspaces type Rep ListWorkspaces = D1 ('MetaData "ListWorkspaces" "Amazonka.AMP.ListWorkspaces" "amazonka-amp-2.0-5Nt9wsU74T2I91dslthaby" 'False) (C1 ('MetaCons "ListWorkspaces'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (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:

ListWorkspaces, listWorkspaces_alias - Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.

$sel:maxResults:ListWorkspaces', listWorkspaces_maxResults - Maximum results to return in response (default=100, maximum=1000).

ListWorkspaces, listWorkspaces_nextToken - Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

Request Lenses

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

Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.

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

Maximum results to return in response (default=100, maximum=1000).

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

Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

Destructuring the Response

data ListWorkspacesResponse Source #

Represents the output of a ListWorkspaces operation.

See: newListWorkspacesResponse smart constructor.

Constructors

ListWorkspacesResponse'
Fields nextToken :: Maybe Text Pagination token to use when requesting the next page in this list. httpStatus :: Int The response's http status code. workspaces :: [WorkspaceSummary] The list of existing workspaces, including those undergoing creation or deletion.

Instances

Instances details

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

newListWorkspacesResponse Source #

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 - Pagination token to use when requesting the next page in this list.

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

$sel:workspaces:ListWorkspacesResponse', listWorkspacesResponse_workspaces - The list of existing workspaces, including those undergoing creation or deletion.

Response Lenses

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

Pagination token to use when requesting the next page in this list.

listWorkspacesResponse_httpStatus :: Lens' ListWorkspacesResponse Int Source #

The response's http status code.

listWorkspacesResponse_workspaces :: Lens' ListWorkspacesResponse [WorkspaceSummary] Source #

The list of existing workspaces, including those undergoing creation or deletion.