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.Nimble.ListStudioComponents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the StudioComponents in a studio.

This operation returns paginated results.

Synopsis

data ListStudioComponents = ListStudioComponents' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- states :: Maybe [StudioComponentState]
- types :: Maybe [StudioComponentType]
- studioId :: Text
}
newListStudioComponents :: Text -> ListStudioComponents
listStudioComponents_maxResults :: Lens' ListStudioComponents (Maybe Natural)
listStudioComponents_nextToken :: Lens' ListStudioComponents (Maybe Text)
listStudioComponents_states :: Lens' ListStudioComponents (Maybe [StudioComponentState])
listStudioComponents_types :: Lens' ListStudioComponents (Maybe [StudioComponentType])
listStudioComponents_studioId :: Lens' ListStudioComponents Text
data ListStudioComponentsResponse = ListStudioComponentsResponse' {
- nextToken :: Maybe Text
- studioComponents :: Maybe [StudioComponent]
- httpStatus :: Int
}
newListStudioComponentsResponse :: Int -> ListStudioComponentsResponse
listStudioComponentsResponse_nextToken :: Lens' ListStudioComponentsResponse (Maybe Text)
listStudioComponentsResponse_studioComponents :: Lens' ListStudioComponentsResponse (Maybe [StudioComponent])
listStudioComponentsResponse_httpStatus :: Lens' ListStudioComponentsResponse Int

Creating a Request

data ListStudioComponents Source #

See: newListStudioComponents smart constructor.

Constructors

ListStudioComponents'

Fields

maxResults :: Maybe Natural
The max number of results to return in the response.
nextToken :: Maybe Text
The token for the next set of results, or null if there are no more results.
states :: Maybe [StudioComponentState]
Filters the request to studio components that are in one of the given states.
types :: Maybe [StudioComponentType]
Filters the request to studio components that are of one of the given types.
studioId :: Text
The studio ID.

Instances

Instances details

ToHeaders ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods toHeaders :: ListStudioComponents -> [Header] #
ToPath ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods toPath :: ListStudioComponents -> ByteString #
ToQuery ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods toQuery :: ListStudioComponents -> QueryString #
AWSPager ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods page :: ListStudioComponents -> AWSResponse ListStudioComponents -> Maybe ListStudioComponents #
AWSRequest ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Associated Types type AWSResponse ListStudioComponents # Methods request :: (Service -> Service) -> ListStudioComponents -> Request ListStudioComponents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStudioComponents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStudioComponents))) #
Generic ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Associated Types type Rep ListStudioComponents :: Type -> Type # Methods from :: ListStudioComponents -> Rep ListStudioComponents x # to :: Rep ListStudioComponents x -> ListStudioComponents #
Read ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods readsPrec :: Int -> ReadS ListStudioComponents # readList :: ReadS [ListStudioComponents] # readPrec :: ReadPrec ListStudioComponents # readListPrec :: ReadPrec [ListStudioComponents] #
Show ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods showsPrec :: Int -> ListStudioComponents -> ShowS # show :: ListStudioComponents -> String # showList :: [ListStudioComponents] -> ShowS #
NFData ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods rnf :: ListStudioComponents -> () #
Eq ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods (==) :: ListStudioComponents -> ListStudioComponents -> Bool # (/=) :: ListStudioComponents -> ListStudioComponents -> Bool #
Hashable ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods hashWithSalt :: Int -> ListStudioComponents -> Int # hash :: ListStudioComponents -> Int #
type AWSResponse ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents type AWSResponse ListStudioComponents = ListStudioComponentsResponse
type Rep ListStudioComponents Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents type Rep ListStudioComponents = D1 ('MetaData "ListStudioComponents" "Amazonka.Nimble.ListStudioComponents" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "ListStudioComponents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "states") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StudioComponentState])) :: (S1 ('MetaSel ('Just "types") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StudioComponentType])) :: S1 ('MetaSel ('Just "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListStudioComponents Source #

Arguments

:: Text	`ListStudioComponents`
-> ListStudioComponents

Create a value of ListStudioComponents 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:ListStudioComponents', listStudioComponents_maxResults - The max number of results to return in the response.

ListStudioComponents, listStudioComponents_nextToken - The token for the next set of results, or null if there are no more results.

$sel:states:ListStudioComponents', listStudioComponents_states - Filters the request to studio components that are in one of the given states.

$sel:types:ListStudioComponents', listStudioComponents_types - Filters the request to studio components that are of one of the given types.

ListStudioComponents, listStudioComponents_studioId - The studio ID.

Request Lenses

listStudioComponents_maxResults :: Lens' ListStudioComponents (Maybe Natural) Source #

The max number of results to return in the response.

listStudioComponents_nextToken :: Lens' ListStudioComponents (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudioComponents_states :: Lens' ListStudioComponents (Maybe [StudioComponentState]) Source #

Filters the request to studio components that are in one of the given states.

listStudioComponents_types :: Lens' ListStudioComponents (Maybe [StudioComponentType]) Source #

Filters the request to studio components that are of one of the given types.

listStudioComponents_studioId :: Lens' ListStudioComponents Text Source #

The studio ID.

Destructuring the Response

data ListStudioComponentsResponse Source #

See: newListStudioComponentsResponse smart constructor.

Constructors

ListStudioComponentsResponse'
Fields nextToken :: Maybe Text The token for the next set of results, or null if there are no more results. studioComponents :: Maybe [StudioComponent] A collection of studio components. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListStudioComponentsResponse Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Associated Types type Rep ListStudioComponentsResponse :: Type -> Type # Methods from :: ListStudioComponentsResponse -> Rep ListStudioComponentsResponse x # to :: Rep ListStudioComponentsResponse x -> ListStudioComponentsResponse #
Show ListStudioComponentsResponse Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods showsPrec :: Int -> ListStudioComponentsResponse -> ShowS # show :: ListStudioComponentsResponse -> String # showList :: [ListStudioComponentsResponse] -> ShowS #
NFData ListStudioComponentsResponse Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods rnf :: ListStudioComponentsResponse -> () #
Eq ListStudioComponentsResponse Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents Methods (==) :: ListStudioComponentsResponse -> ListStudioComponentsResponse -> Bool # (/=) :: ListStudioComponentsResponse -> ListStudioComponentsResponse -> Bool #
type Rep ListStudioComponentsResponse Source #
Instance details Defined in Amazonka.Nimble.ListStudioComponents type Rep ListStudioComponentsResponse = D1 ('MetaData "ListStudioComponentsResponse" "Amazonka.Nimble.ListStudioComponents" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "ListStudioComponentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "studioComponents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StudioComponent])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStudioComponentsResponse Source #

Arguments

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

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

ListStudioComponents, listStudioComponentsResponse_nextToken - The token for the next set of results, or null if there are no more results.

$sel:studioComponents:ListStudioComponentsResponse', listStudioComponentsResponse_studioComponents - A collection of studio components.

$sel:httpStatus:ListStudioComponentsResponse', listStudioComponentsResponse_httpStatus - The response's http status code.

Response Lenses

listStudioComponentsResponse_nextToken :: Lens' ListStudioComponentsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listStudioComponentsResponse_studioComponents :: Lens' ListStudioComponentsResponse (Maybe [StudioComponent]) Source #

A collection of studio components.

listStudioComponentsResponse_httpStatus :: Lens' ListStudioComponentsResponse Int Source #

The response's http status code.