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.QuickSight.ListTemplates

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the templates in the current Amazon QuickSight account.

This operation returns paginated results.

Synopsis

data ListTemplates = ListTemplates' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- awsAccountId :: Text
}
newListTemplates :: Text -> ListTemplates
listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural)
listTemplates_nextToken :: Lens' ListTemplates (Maybe Text)
listTemplates_awsAccountId :: Lens' ListTemplates Text
data ListTemplatesResponse = ListTemplatesResponse' {
- nextToken :: Maybe Text
- requestId :: Maybe Text
- templateSummaryList :: Maybe [TemplateSummary]
- status :: Int
}
newListTemplatesResponse :: Int -> ListTemplatesResponse
listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text)
listTemplatesResponse_requestId :: Lens' ListTemplatesResponse (Maybe Text)
listTemplatesResponse_templateSummaryList :: Lens' ListTemplatesResponse (Maybe [TemplateSummary])
listTemplatesResponse_status :: Lens' ListTemplatesResponse Int

Creating a Request

data ListTemplates Source #

See: newListTemplates smart constructor.

Constructors

ListTemplates'
Fields maxResults :: Maybe Natural The maximum number of results to be returned per request. nextToken :: Maybe Text The token for the next set of results, or null if there are no more results. awsAccountId :: Text The ID of the Amazon Web Services account that contains the templates that you're listing.

Instances

Instances details

ToHeaders ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods toHeaders :: ListTemplates -> [Header] #
ToPath ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods toPath :: ListTemplates -> ByteString #
ToQuery ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods toQuery :: ListTemplates -> QueryString #
AWSPager ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods page :: ListTemplates -> AWSResponse ListTemplates -> Maybe ListTemplates #
AWSRequest ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Associated Types type AWSResponse ListTemplates # Methods request :: (Service -> Service) -> ListTemplates -> Request ListTemplates # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTemplates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTemplates))) #
Generic ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Associated Types type Rep ListTemplates :: Type -> Type # Methods from :: ListTemplates -> Rep ListTemplates x # to :: Rep ListTemplates x -> ListTemplates #
Read ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods readsPrec :: Int -> ReadS ListTemplates # readList :: ReadS [ListTemplates] # readPrec :: ReadPrec ListTemplates # readListPrec :: ReadPrec [ListTemplates] #
Show ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods showsPrec :: Int -> ListTemplates -> ShowS # show :: ListTemplates -> String # showList :: [ListTemplates] -> ShowS #
NFData ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods rnf :: ListTemplates -> () #
Eq ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods (==) :: ListTemplates -> ListTemplates -> Bool # (/=) :: ListTemplates -> ListTemplates -> Bool #
Hashable ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods hashWithSalt :: Int -> ListTemplates -> Int # hash :: ListTemplates -> Int #
type AWSResponse ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates type AWSResponse ListTemplates = ListTemplatesResponse
type Rep ListTemplates Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates type Rep ListTemplates = D1 ('MetaData "ListTemplates" "Amazonka.QuickSight.ListTemplates" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "ListTemplates'" '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 "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListTemplates Source #

Arguments

:: Text	`ListTemplates`
-> ListTemplates

Create a value of ListTemplates 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:ListTemplates', listTemplates_maxResults - The maximum number of results to be returned per request.

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

ListTemplates, listTemplates_awsAccountId - The ID of the Amazon Web Services account that contains the templates that you're listing.

Request Lenses

listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural) Source #

The maximum number of results to be returned per request.

listTemplates_nextToken :: Lens' ListTemplates (Maybe Text) Source #

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

listTemplates_awsAccountId :: Lens' ListTemplates Text Source #

The ID of the Amazon Web Services account that contains the templates that you're listing.

Destructuring the Response

data ListTemplatesResponse Source #

See: newListTemplatesResponse smart constructor.

Constructors

ListTemplatesResponse'
Fields nextToken :: Maybe Text The token for the next set of results, or null if there are no more results. requestId :: Maybe Text The Amazon Web Services request ID for this operation. templateSummaryList :: Maybe [TemplateSummary] A structure containing information about the templates in the list. status :: Int The HTTP status of the request.

Instances

Instances details

Generic ListTemplatesResponse Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Associated Types type Rep ListTemplatesResponse :: Type -> Type # Methods from :: ListTemplatesResponse -> Rep ListTemplatesResponse x # to :: Rep ListTemplatesResponse x -> ListTemplatesResponse #
Read ListTemplatesResponse Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods readsPrec :: Int -> ReadS ListTemplatesResponse # readList :: ReadS [ListTemplatesResponse] # readPrec :: ReadPrec ListTemplatesResponse # readListPrec :: ReadPrec [ListTemplatesResponse] #
Show ListTemplatesResponse Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods showsPrec :: Int -> ListTemplatesResponse -> ShowS # show :: ListTemplatesResponse -> String # showList :: [ListTemplatesResponse] -> ShowS #
NFData ListTemplatesResponse Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods rnf :: ListTemplatesResponse -> () #
Eq ListTemplatesResponse Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates Methods (==) :: ListTemplatesResponse -> ListTemplatesResponse -> Bool # (/=) :: ListTemplatesResponse -> ListTemplatesResponse -> Bool #
type Rep ListTemplatesResponse Source #
Instance details Defined in Amazonka.QuickSight.ListTemplates type Rep ListTemplatesResponse = D1 ('MetaData "ListTemplatesResponse" "Amazonka.QuickSight.ListTemplates" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "ListTemplatesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "templateSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TemplateSummary])) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTemplatesResponse Source #

Arguments

:: Int	`ListTemplatesResponse`
-> ListTemplatesResponse

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

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

$sel:requestId:ListTemplatesResponse', listTemplatesResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:templateSummaryList:ListTemplatesResponse', listTemplatesResponse_templateSummaryList - A structure containing information about the templates in the list.

ListTemplatesResponse, listTemplatesResponse_status - The HTTP status of the request.

Response Lenses

listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text) Source #

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

listTemplatesResponse_requestId :: Lens' ListTemplatesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listTemplatesResponse_templateSummaryList :: Lens' ListTemplatesResponse (Maybe [TemplateSummary]) Source #

A structure containing information about the templates in the list.

listTemplatesResponse_status :: Lens' ListTemplatesResponse Int Source #

The HTTP status of the request.