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

Description

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

Synopsis

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

Read GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Show GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Generic GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Associated Types

type Rep GetSegmentExportJobs :: Type -> Type #

NFData GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Methods

rnf :: GetSegmentExportJobs -> () #

Hashable GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

AWSRequest GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Associated Types

type AWSResponse GetSegmentExportJobs #

ToHeaders GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

ToPath GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

ToQuery GetSegmentExportJobs Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

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

newGetSegmentExportJobs Source #

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

Instances

Instances details
Eq GetSegmentExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Read GetSegmentExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Show GetSegmentExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Generic GetSegmentExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

Associated Types

type Rep GetSegmentExportJobsResponse :: Type -> Type #

NFData GetSegmentExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegmentExportJobs

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 #

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