Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.GetSegmentExportJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about the status and settings of the export jobs for a segment.

Synopsis

data GetSegmentExportJobs = GetSegmentExportJobs' {
- token :: Maybe Text
- pageSize :: Maybe Text
- segmentId :: Text
- applicationId :: Text
}
newGetSegmentExportJobs :: Text -> Text -> GetSegmentExportJobs
getSegmentExportJobs_token :: Lens' GetSegmentExportJobs (Maybe Text)
getSegmentExportJobs_pageSize :: Lens' GetSegmentExportJobs (Maybe Text)
getSegmentExportJobs_segmentId :: Lens' GetSegmentExportJobs Text
getSegmentExportJobs_applicationId :: Lens' GetSegmentExportJobs Text
data GetSegmentExportJobsResponse = GetSegmentExportJobsResponse' {
- httpStatus :: Int
- exportJobsResponse :: ExportJobsResponse
}
newGetSegmentExportJobsResponse :: Int -> ExportJobsResponse -> GetSegmentExportJobsResponse
getSegmentExportJobsResponse_httpStatus :: Lens' GetSegmentExportJobsResponse Int
getSegmentExportJobsResponse_exportJobsResponse :: Lens' GetSegmentExportJobsResponse ExportJobsResponse

Creating a Request

data GetSegmentExportJobs Source #

See: newGetSegmentExportJobs smart constructor.

Constructors

GetSegmentExportJobs'

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.
segmentId :: Text
The unique identifier for the segment.
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 GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods (==) :: GetSegmentExportJobs -> GetSegmentExportJobs -> Bool # (/=) :: GetSegmentExportJobs -> GetSegmentExportJobs -> Bool #
Read GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods readsPrec :: Int -> ReadS GetSegmentExportJobs # readList :: ReadS [GetSegmentExportJobs] # readPrec :: ReadPrec GetSegmentExportJobs # readListPrec :: ReadPrec [GetSegmentExportJobs] #
Show GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods showsPrec :: Int -> GetSegmentExportJobs -> ShowS # show :: GetSegmentExportJobs -> String # showList :: [GetSegmentExportJobs] -> ShowS #
Generic GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Associated Types type Rep GetSegmentExportJobs :: Type -> Type # Methods from :: GetSegmentExportJobs -> Rep GetSegmentExportJobs x # to :: Rep GetSegmentExportJobs x -> GetSegmentExportJobs #
NFData GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods rnf :: GetSegmentExportJobs -> () #
Hashable GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods hashWithSalt :: Int -> GetSegmentExportJobs -> Int # hash :: GetSegmentExportJobs -> Int #
AWSRequest GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Associated Types type AWSResponse GetSegmentExportJobs # Methods request :: GetSegmentExportJobs -> Request GetSegmentExportJobs # response :: MonadResource m => Logger -> Service -> Proxy GetSegmentExportJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSegmentExportJobs))) #
ToHeaders GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods toHeaders :: GetSegmentExportJobs -> [Header] #
ToPath GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods toPath :: GetSegmentExportJobs -> ByteString #
ToQuery GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods toQuery :: GetSegmentExportJobs -> QueryString #
type Rep GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs type Rep GetSegmentExportJobs = D1 ('MetaData "GetSegmentExportJobs" "Amazonka.Pinpoint.GetSegmentExportJobs" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetSegmentExportJobs'" '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 "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetSegmentExportJobs Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs type AWSResponse GetSegmentExportJobs = GetSegmentExportJobsResponse

newGetSegmentExportJobs Source #

Arguments

:: Text	`$sel:segmentId:GetSegmentExportJobs'`
-> Text	`$sel:applicationId:GetSegmentExportJobs'`
-> GetSegmentExportJobs

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

$sel:pageSize:GetSegmentExportJobs', getSegmentExportJobs_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:segmentId:GetSegmentExportJobs', getSegmentExportJobs_segmentId - The unique identifier for the segment.

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

Request Lenses

getSegmentExportJobs_token :: Lens' GetSegmentExportJobs (Maybe Text) Source #

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

getSegmentExportJobs_pageSize :: Lens' GetSegmentExportJobs (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.

getSegmentExportJobs_segmentId :: Lens' GetSegmentExportJobs Text Source #

The unique identifier for the segment.

getSegmentExportJobs_applicationId :: Lens' GetSegmentExportJobs 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 GetSegmentExportJobsResponse Source #

See: newGetSegmentExportJobsResponse smart constructor.

Constructors

GetSegmentExportJobsResponse'
Fields httpStatus :: Int The response's http status code. exportJobsResponse :: ExportJobsResponse

Instances

Instances details

Eq GetSegmentExportJobsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods (==) :: GetSegmentExportJobsResponse -> GetSegmentExportJobsResponse -> Bool # (/=) :: GetSegmentExportJobsResponse -> GetSegmentExportJobsResponse -> Bool #
Read GetSegmentExportJobsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods readsPrec :: Int -> ReadS GetSegmentExportJobsResponse # readList :: ReadS [GetSegmentExportJobsResponse] # readPrec :: ReadPrec GetSegmentExportJobsResponse # readListPrec :: ReadPrec [GetSegmentExportJobsResponse] #
Show GetSegmentExportJobsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods showsPrec :: Int -> GetSegmentExportJobsResponse -> ShowS # show :: GetSegmentExportJobsResponse -> String # showList :: [GetSegmentExportJobsResponse] -> ShowS #
Generic GetSegmentExportJobsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Associated Types type Rep GetSegmentExportJobsResponse :: Type -> Type # Methods from :: GetSegmentExportJobsResponse -> Rep GetSegmentExportJobsResponse x # to :: Rep GetSegmentExportJobsResponse x -> GetSegmentExportJobsResponse #
NFData GetSegmentExportJobsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs Methods rnf :: GetSegmentExportJobsResponse -> () #
type Rep GetSegmentExportJobsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetSegmentExportJobs type Rep GetSegmentExportJobsResponse = D1 ('MetaData "GetSegmentExportJobsResponse" "Amazonka.Pinpoint.GetSegmentExportJobs" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetSegmentExportJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "exportJobsResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExportJobsResponse)))

newGetSegmentExportJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSegmentExportJobsResponse'`
-> ExportJobsResponse	`$sel:exportJobsResponse:GetSegmentExportJobsResponse'`
-> GetSegmentExportJobsResponse

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

$sel:exportJobsResponse:GetSegmentExportJobsResponse', getSegmentExportJobsResponse_exportJobsResponse - Undocumented member.

Response Lenses

getSegmentExportJobsResponse_httpStatus :: Lens' GetSegmentExportJobsResponse Int Source #

The response's http status code.

getSegmentExportJobsResponse_exportJobsResponse :: Lens' GetSegmentExportJobsResponse ExportJobsResponse Source #

Undocumented member.