Amazonka.Pinpoint.ListJourneys

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

Creating a Request

data ListJourneys

See: newListJourneys smart constructor.

Constructors

ListJourneys'

Fields

• 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.

• token :: Maybe Text

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

• applicationId :: Text

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

Instances

ToHeaders ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

toHeaders :: ListJourneys -> [Header]

ToPath ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

toPath :: ListJourneys -> ByteString

ToQuery ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

toQuery :: ListJourneys -> QueryString

AWSRequest ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Associated Types

type AWSResponse ListJourneys

Methods

request :: (Service -> Service) -> ListJourneys -> Request ListJourneys

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

Generic ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Associated Types

type Rep ListJourneys :: Type -> Type

Methods

from :: ListJourneys -> Rep ListJourneys x

to :: Rep ListJourneys x -> ListJourneys

Read ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

readsPrec :: Int -> ReadS ListJourneys

readList :: ReadS [ListJourneys]

readPrec :: ReadPrec ListJourneys

readListPrec :: ReadPrec [ListJourneys]

Show ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

showsPrec :: Int -> ListJourneys -> ShowS

show :: ListJourneys -> String

showList :: [ListJourneys] -> ShowS

NFData ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

rnf :: ListJourneys -> ()

Eq ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

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

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

Hashable ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

Methods

hashWithSalt :: Int -> ListJourneys -> Int

hash :: ListJourneys -> Int

type AWSResponse ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

type AWSResponse ListJourneys = ListJourneysResponse

type Rep ListJourneys

Defined in Amazonka.Pinpoint.ListJourneys

type Rep ListJourneys = D1 ('MetaData "ListJourneys" "Amazonka.Pinpoint.ListJourneys" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "ListJourneys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListJourneys

Arguments

:: Text

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

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_pageSize :: Lens' ListJourneys (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.

listJourneys_token :: Lens' ListJourneys (Maybe Text)

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

listJourneys_applicationId :: Lens' ListJourneys Text

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

Destructuring the Response

data ListJourneysResponse

See: newListJourneysResponse smart constructor.

Constructors

ListJourneysResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• journeysResponse :: JourneysResponse

Instances

Generic ListJourneysResponse

Defined in Amazonka.Pinpoint.ListJourneys

Associated Types

type Rep ListJourneysResponse :: Type -> Type

Methods

from :: ListJourneysResponse -> Rep ListJourneysResponse x

to :: Rep ListJourneysResponse x -> ListJourneysResponse

Read ListJourneysResponse

Defined in Amazonka.Pinpoint.ListJourneys

Methods

readsPrec :: Int -> ReadS ListJourneysResponse

readList :: ReadS [ListJourneysResponse]

readPrec :: ReadPrec ListJourneysResponse

readListPrec :: ReadPrec [ListJourneysResponse]

Show ListJourneysResponse

Defined in Amazonka.Pinpoint.ListJourneys

Methods

showsPrec :: Int -> ListJourneysResponse -> ShowS

show :: ListJourneysResponse -> String

showList :: [ListJourneysResponse] -> ShowS

NFData ListJourneysResponse

Defined in Amazonka.Pinpoint.ListJourneys

Methods

rnf :: ListJourneysResponse -> ()

Eq ListJourneysResponse

Defined in Amazonka.Pinpoint.ListJourneys

Methods

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

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

type Rep ListJourneysResponse

Defined in Amazonka.Pinpoint.ListJourneys

type Rep ListJourneysResponse = D1 ('MetaData "ListJourneysResponse" "Amazonka.Pinpoint.ListJourneys" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" '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

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

The response's http status code.

listJourneysResponse_journeysResponse :: Lens' ListJourneysResponse JourneysResponse

Undocumented member.