Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.GetSegmentImportJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data GetSegmentImportJobs = GetSegmentImportJobs' {
- pageSize :: Maybe Text
- token :: Maybe Text
- segmentId :: Text
- applicationId :: Text
}
newGetSegmentImportJobs :: Text -> Text -> GetSegmentImportJobs
getSegmentImportJobs_pageSize :: Lens' GetSegmentImportJobs (Maybe Text)
getSegmentImportJobs_token :: Lens' GetSegmentImportJobs (Maybe Text)
getSegmentImportJobs_segmentId :: Lens' GetSegmentImportJobs Text
getSegmentImportJobs_applicationId :: Lens' GetSegmentImportJobs Text
data GetSegmentImportJobsResponse = GetSegmentImportJobsResponse' {
- httpStatus :: Int
- importJobsResponse :: ImportJobsResponse
}
newGetSegmentImportJobsResponse :: Int -> ImportJobsResponse -> GetSegmentImportJobsResponse
getSegmentImportJobsResponse_httpStatus :: Lens' GetSegmentImportJobsResponse Int
getSegmentImportJobsResponse_importJobsResponse :: Lens' GetSegmentImportJobsResponse ImportJobsResponse

Creating a Request

data GetSegmentImportJobs Source #

See: newGetSegmentImportJobs smart constructor.

Constructors

GetSegmentImportJobs'

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

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

newGetSegmentImportJobs Source #

Arguments

:: Text	`GetSegmentImportJobs`
-> Text	`GetSegmentImportJobs`
-> GetSegmentImportJobs

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

GetSegmentImportJobs, getSegmentImportJobs_segmentId - The unique identifier for the segment.

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

Request Lenses

getSegmentImportJobs_pageSize :: Lens' GetSegmentImportJobs (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.

getSegmentImportJobs_token :: Lens' GetSegmentImportJobs (Maybe Text) Source #

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

getSegmentImportJobs_segmentId :: Lens' GetSegmentImportJobs Text Source #

The unique identifier for the segment.

getSegmentImportJobs_applicationId :: Lens' GetSegmentImportJobs 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 GetSegmentImportJobsResponse Source #

See: newGetSegmentImportJobsResponse smart constructor.

Constructors

GetSegmentImportJobsResponse'
Fields httpStatus :: Int The response's http status code. importJobsResponse :: ImportJobsResponse

Instances

Instances details

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

newGetSegmentImportJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSegmentImportJobsResponse'`
-> ImportJobsResponse	`$sel:importJobsResponse:GetSegmentImportJobsResponse'`
-> GetSegmentImportJobsResponse

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

$sel:importJobsResponse:GetSegmentImportJobsResponse', getSegmentImportJobsResponse_importJobsResponse - Undocumented member.

Response Lenses

getSegmentImportJobsResponse_httpStatus :: Lens' GetSegmentImportJobsResponse Int Source #

The response's http status code.

getSegmentImportJobsResponse_importJobsResponse :: Lens' GetSegmentImportJobsResponse ImportJobsResponse Source #

Undocumented member.