amazonka-iotfleetwise-2.0: Amazon IoT FleetWise 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.IoTFleetWise.ListCampaigns

Description

Lists information about created campaigns.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCampaigns Source #

See: newListCampaigns smart constructor.

Constructors

ListCampaigns' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of items to return, between 1 and 100, inclusive.

  • nextToken :: Maybe Text

    A pagination token for the next set of results.

    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

  • status :: Maybe Text

    Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

Instances

Instances details
ToJSON ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

toJSON :: ListCampaigns -> Value #

toEncoding :: ListCampaigns -> Encoding #

toJSONList :: [ListCampaigns] -> Value #

toEncodingList :: [ListCampaigns] -> Encoding #

ToHeaders ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

toHeaders :: ListCampaigns -> [Header] #

ToPath ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

toPath :: ListCampaigns -> ByteString #

ToQuery ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

toQuery :: ListCampaigns -> QueryString #

AWSPager ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

page :: ListCampaigns -> AWSResponse ListCampaigns -> Maybe ListCampaigns #

AWSRequest ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Associated Types

type AWSResponse ListCampaigns #

Methods

request :: (Service -> Service) -> ListCampaigns -> Request ListCampaigns #

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

Generic ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Associated Types

type Rep ListCampaigns :: Type -> Type #

Methods

from :: ListCampaigns -> Rep ListCampaigns x #

to :: Rep ListCampaigns x -> ListCampaigns #

Read ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

readsPrec :: Int -> ReadS ListCampaigns #

readList :: ReadS [ListCampaigns] #

readPrec :: ReadPrec ListCampaigns #

readListPrec :: ReadPrec [ListCampaigns] #

Show ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

showsPrec :: Int -> ListCampaigns -> ShowS #

show :: ListCampaigns -> String #

showList :: [ListCampaigns] -> ShowS #

NFData ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

rnf :: ListCampaigns -> () #

Eq ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

(==) :: ListCampaigns -> ListCampaigns -> Bool #

(/=) :: ListCampaigns -> ListCampaigns -> Bool #

Hashable ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

hashWithSalt :: Int -> ListCampaigns -> Int #

hash :: ListCampaigns -> Int #

type AWSResponse ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

type AWSResponse ListCampaigns = ListCampaignsResponse
type Rep ListCampaigns Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

type Rep ListCampaigns = D1 ('MetaData "ListCampaigns" "Amazonka.IoTFleetWise.ListCampaigns" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "ListCampaigns'" '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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListCampaigns :: ListCampaigns Source #

Create a value of ListCampaigns 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:ListCampaigns', listCampaigns_maxResults - The maximum number of items to return, between 1 and 100, inclusive.

ListCampaigns, listCampaigns_nextToken - A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

ListCampaigns, listCampaigns_status - Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

Request Lenses

listCampaigns_maxResults :: Lens' ListCampaigns (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listCampaigns_nextToken :: Lens' ListCampaigns (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listCampaigns_status :: Lens' ListCampaigns (Maybe Text) Source #

Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

Destructuring the Response

data ListCampaignsResponse Source #

See: newListCampaignsResponse smart constructor.

Constructors

ListCampaignsResponse' 

Fields

Instances

Instances details
Generic ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Associated Types

type Rep ListCampaignsResponse :: Type -> Type #

Methods

from :: ListCampaignsResponse -> Rep ListCampaignsResponse x #

to :: Rep ListCampaignsResponse x -> ListCampaignsResponse #

Read ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

readsPrec :: Int -> ReadS ListCampaignsResponse #

readList :: ReadS [ListCampaignsResponse] #

readPrec :: ReadPrec ListCampaignsResponse #

readListPrec :: ReadPrec [ListCampaignsResponse] #

Show ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

showsPrec :: Int -> ListCampaignsResponse -> ShowS #

show :: ListCampaignsResponse -> String #

showList :: [ListCampaignsResponse] -> ShowS #

NFData ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

rnf :: ListCampaignsResponse -> () #

Eq ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

Methods

(==) :: ListCampaignsResponse -> ListCampaignsResponse -> Bool #

(/=) :: ListCampaignsResponse -> ListCampaignsResponse -> Bool #

type Rep ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListCampaigns

type Rep ListCampaignsResponse = D1 ('MetaData "ListCampaignsResponse" "Amazonka.IoTFleetWise.ListCampaigns" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "ListCampaignsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaignSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CampaignSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCampaignsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListCampaignsResponse'

-> ListCampaignsResponse 

Create a value of ListCampaignsResponse 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:campaignSummaries:ListCampaignsResponse', listCampaignsResponse_campaignSummaries - A summary of information about each campaign.

ListCampaigns, listCampaignsResponse_nextToken - The token to retrieve the next set of results, or null if there are no more results.

$sel:httpStatus:ListCampaignsResponse', listCampaignsResponse_httpStatus - The response's http status code.

Response Lenses

listCampaignsResponse_campaignSummaries :: Lens' ListCampaignsResponse (Maybe [CampaignSummary]) Source #

A summary of information about each campaign.

listCampaignsResponse_nextToken :: Lens' ListCampaignsResponse (Maybe Text) Source #

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

listCampaignsResponse_httpStatus :: Lens' ListCampaignsResponse Int Source #

The response's http status code.