Amazonka.Personalize.ListBatchSegmentJobs

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

This operation returns paginated results.

Creating a Request

data ListBatchSegmentJobs

See: newListBatchSegmentJobs smart constructor.

Constructors

ListBatchSegmentJobs'

Fields

• maxResults :: Maybe Natural

  The maximum number of batch segment job results to return in each page. The default value is 100.

• nextToken :: Maybe Text

  The token to request the next page of results.

• solutionVersionArn :: Maybe Text

  The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

Instances

ToJSON ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

toJSON :: ListBatchSegmentJobs -> Value

toEncoding :: ListBatchSegmentJobs -> Encoding

toJSONList :: [ListBatchSegmentJobs] -> Value

toEncodingList :: [ListBatchSegmentJobs] -> Encoding

ToHeaders ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

toHeaders :: ListBatchSegmentJobs -> [Header]

ToPath ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

toPath :: ListBatchSegmentJobs -> ByteString

ToQuery ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

toQuery :: ListBatchSegmentJobs -> QueryString

AWSPager ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

page :: ListBatchSegmentJobs -> AWSResponse ListBatchSegmentJobs -> Maybe ListBatchSegmentJobs

AWSRequest ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Associated Types

type AWSResponse ListBatchSegmentJobs

Methods

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

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

Generic ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Associated Types

type Rep ListBatchSegmentJobs :: Type -> Type

Methods

from :: ListBatchSegmentJobs -> Rep ListBatchSegmentJobs x

to :: Rep ListBatchSegmentJobs x -> ListBatchSegmentJobs

Read ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

readsPrec :: Int -> ReadS ListBatchSegmentJobs

readList :: ReadS [ListBatchSegmentJobs]

readPrec :: ReadPrec ListBatchSegmentJobs

readListPrec :: ReadPrec [ListBatchSegmentJobs]

Show ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

showsPrec :: Int -> ListBatchSegmentJobs -> ShowS

show :: ListBatchSegmentJobs -> String

showList :: [ListBatchSegmentJobs] -> ShowS

NFData ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

rnf :: ListBatchSegmentJobs -> ()

Eq ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

(==) :: ListBatchSegmentJobs -> ListBatchSegmentJobs -> Bool

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

Hashable ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

hashWithSalt :: Int -> ListBatchSegmentJobs -> Int

hash :: ListBatchSegmentJobs -> Int

type AWSResponse ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

type AWSResponse ListBatchSegmentJobs = ListBatchSegmentJobsResponse

type Rep ListBatchSegmentJobs

Defined in Amazonka.Personalize.ListBatchSegmentJobs

type Rep ListBatchSegmentJobs = D1 ('MetaData "ListBatchSegmentJobs" "Amazonka.Personalize.ListBatchSegmentJobs" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "ListBatchSegmentJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "solutionVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListBatchSegmentJobs :: ListBatchSegmentJobs

Create a value of ListBatchSegmentJobs 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:maxResults:ListBatchSegmentJobs', listBatchSegmentJobs_maxResults - The maximum number of batch segment job results to return in each page. The default value is 100.

ListBatchSegmentJobs, listBatchSegmentJobs_nextToken - The token to request the next page of results.

ListBatchSegmentJobs, listBatchSegmentJobs_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

Request Lenses

listBatchSegmentJobs_maxResults :: Lens' ListBatchSegmentJobs (Maybe Natural)

The maximum number of batch segment job results to return in each page. The default value is 100.

listBatchSegmentJobs_nextToken :: Lens' ListBatchSegmentJobs (Maybe Text)

The token to request the next page of results.

listBatchSegmentJobs_solutionVersionArn :: Lens' ListBatchSegmentJobs (Maybe Text)

The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

Destructuring the Response

data ListBatchSegmentJobsResponse

See: newListBatchSegmentJobsResponse smart constructor.

Constructors

ListBatchSegmentJobsResponse'

Fields

• batchSegmentJobs :: Maybe [BatchSegmentJobSummary]

  A list containing information on each job that is returned.

• nextToken :: Maybe Text

  The token to use to retrieve the next page of results. The value is null when there are no more results to return.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListBatchSegmentJobsResponse

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Associated Types

type Rep ListBatchSegmentJobsResponse :: Type -> Type

Methods

from :: ListBatchSegmentJobsResponse -> Rep ListBatchSegmentJobsResponse x

to :: Rep ListBatchSegmentJobsResponse x -> ListBatchSegmentJobsResponse

Read ListBatchSegmentJobsResponse

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

readsPrec :: Int -> ReadS ListBatchSegmentJobsResponse

readList :: ReadS [ListBatchSegmentJobsResponse]

readPrec :: ReadPrec ListBatchSegmentJobsResponse

readListPrec :: ReadPrec [ListBatchSegmentJobsResponse]

Show ListBatchSegmentJobsResponse

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

showsPrec :: Int -> ListBatchSegmentJobsResponse -> ShowS

show :: ListBatchSegmentJobsResponse -> String

showList :: [ListBatchSegmentJobsResponse] -> ShowS

NFData ListBatchSegmentJobsResponse

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

rnf :: ListBatchSegmentJobsResponse -> ()

Eq ListBatchSegmentJobsResponse

Defined in Amazonka.Personalize.ListBatchSegmentJobs

Methods

(==) :: ListBatchSegmentJobsResponse -> ListBatchSegmentJobsResponse -> Bool

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

type Rep ListBatchSegmentJobsResponse

Defined in Amazonka.Personalize.ListBatchSegmentJobs

type Rep ListBatchSegmentJobsResponse = D1 ('MetaData "ListBatchSegmentJobsResponse" "Amazonka.Personalize.ListBatchSegmentJobs" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "ListBatchSegmentJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchSegmentJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchSegmentJobSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBatchSegmentJobsResponse

Arguments

:: Int

$sel:httpStatus:ListBatchSegmentJobsResponse'

-> ListBatchSegmentJobsResponse

Create a value of ListBatchSegmentJobsResponse 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:batchSegmentJobs:ListBatchSegmentJobsResponse', listBatchSegmentJobsResponse_batchSegmentJobs - A list containing information on each job that is returned.

ListBatchSegmentJobs, listBatchSegmentJobsResponse_nextToken - The token to use to retrieve the next page of results. The value is null when there are no more results to return.

$sel:httpStatus:ListBatchSegmentJobsResponse', listBatchSegmentJobsResponse_httpStatus - The response's http status code.

Response Lenses

listBatchSegmentJobsResponse_batchSegmentJobs :: Lens' ListBatchSegmentJobsResponse (Maybe [BatchSegmentJobSummary])

A list containing information on each job that is returned.

listBatchSegmentJobsResponse_nextToken :: Lens' ListBatchSegmentJobsResponse (Maybe Text)

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

listBatchSegmentJobsResponse_httpStatus :: Lens' ListBatchSegmentJobsResponse Int

The response's http status code.