libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pinpoint.ListJourneys

Description

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

Synopsis

Creating a Request

data ListJourneys Source #

See: newListJourneys smart constructor.

Constructors

ListJourneys' 

Fields

  • token :: Maybe Text

    The NextToken string that specifies which page of results to return in a paginated response.

  • pageSize :: Maybe Text

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

  • applicationId :: Text

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Instances

Instances details
Eq ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

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

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

Read ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

readsPrec :: Int -> ReadS ListJourneys #

readList :: ReadS [ListJourneys] #

readPrec :: ReadPrec ListJourneys #

readListPrec :: ReadPrec [ListJourneys] #

Show ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

showsPrec :: Int -> ListJourneys -> ShowS #

show :: ListJourneys -> String #

showList :: [ListJourneys] -> ShowS #

Generic ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Associated Types

type Rep ListJourneys :: Type -> Type #

Methods

from :: ListJourneys -> Rep ListJourneys x #

to :: Rep ListJourneys x -> ListJourneys #

NFData ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

rnf :: ListJourneys -> () #

Hashable ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

hashWithSalt :: Int -> ListJourneys -> Int #

hash :: ListJourneys -> Int #

AWSRequest ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Associated Types

type AWSResponse ListJourneys #

Methods

request :: ListJourneys -> Request ListJourneys #

response :: MonadResource m => Logger -> Service -> Proxy ListJourneys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJourneys))) #

ToHeaders ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

toHeaders :: ListJourneys -> [Header] #

ToPath ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

toPath :: ListJourneys -> ByteString #

ToQuery ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

toQuery :: ListJourneys -> QueryString #

type Rep ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

type Rep ListJourneys = D1 ('MetaData "ListJourneys" "Amazonka.Pinpoint.ListJourneys" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ListJourneys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListJourneys Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

type AWSResponse ListJourneys = ListJourneysResponse

newListJourneys Source #

Arguments

:: Text

$sel:applicationId:ListJourneys'

-> ListJourneys 

Create a value of ListJourneys 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:token:ListJourneys', listJourneys_token - The NextToken string that specifies which page of results to return in a paginated response.

$sel:pageSize:ListJourneys', listJourneys_pageSize - The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

$sel:applicationId:ListJourneys', listJourneys_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Request Lenses

listJourneys_token :: Lens' ListJourneys (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

listJourneys_pageSize :: Lens' ListJourneys (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listJourneys_applicationId :: Lens' ListJourneys Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Destructuring the Response

data ListJourneysResponse Source #

See: newListJourneysResponse smart constructor.

Constructors

ListJourneysResponse' 

Fields

Instances

Instances details
Eq ListJourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

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

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

Read ListJourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

readsPrec :: Int -> ReadS ListJourneysResponse #

readList :: ReadS [ListJourneysResponse] #

readPrec :: ReadPrec ListJourneysResponse #

readListPrec :: ReadPrec [ListJourneysResponse] #

Show ListJourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

showsPrec :: Int -> ListJourneysResponse -> ShowS #

show :: ListJourneysResponse -> String #

showList :: [ListJourneysResponse] -> ShowS #

Generic ListJourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Associated Types

type Rep ListJourneysResponse :: Type -> Type #

Methods

from :: ListJourneysResponse -> Rep ListJourneysResponse x #

to :: Rep ListJourneysResponse x -> ListJourneysResponse #

NFData ListJourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

Methods

rnf :: ListJourneysResponse -> () #

type Rep ListJourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListJourneys

type Rep ListJourneysResponse = D1 ('MetaData "ListJourneysResponse" "Amazonka.Pinpoint.ListJourneys" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ListJourneysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "journeysResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JourneysResponse)))

newListJourneysResponse Source #

Arguments

:: Int

$sel:httpStatus:ListJourneysResponse'

-> JourneysResponse

$sel:journeysResponse:ListJourneysResponse'

-> ListJourneysResponse 

Create a value of ListJourneysResponse 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:httpStatus:ListJourneysResponse', listJourneysResponse_httpStatus - The response's http status code.

$sel:journeysResponse:ListJourneysResponse', listJourneysResponse_journeysResponse - Undocumented member.

Response Lenses

listJourneysResponse_httpStatus :: Lens' ListJourneysResponse Int Source #

The response's http status code.

listJourneysResponse_journeysResponse :: Lens' ListJourneysResponse JourneysResponse Source #

Undocumented member.