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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of vector enrichment jobs.

This operation returns paginated results.

Synopsis

Creating a Request

data ListVectorEnrichmentJobs Source #

See: newListVectorEnrichmentJobs smart constructor.

Constructors

ListVectorEnrichmentJobs'

Fields

maxResults :: Maybe Natural
The maximum number of items to return.
nextToken :: Maybe (Sensitive Text)
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
sortBy :: Maybe Text
The parameter by which to sort the results.
sortOrder :: Maybe SortOrder
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
statusEquals :: Maybe Text
A filter that retrieves only jobs with a specific status.

Instances

Instances details

ToJSON ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods toJSON :: ListVectorEnrichmentJobs -> Value # toEncoding :: ListVectorEnrichmentJobs -> Encoding # toJSONList :: [ListVectorEnrichmentJobs] -> Value # toEncodingList :: [ListVectorEnrichmentJobs] -> Encoding #
ToHeaders ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods toHeaders :: ListVectorEnrichmentJobs -> [Header] #
ToPath ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods toPath :: ListVectorEnrichmentJobs -> ByteString #
ToQuery ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods toQuery :: ListVectorEnrichmentJobs -> QueryString #
AWSPager ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods page :: ListVectorEnrichmentJobs -> AWSResponse ListVectorEnrichmentJobs -> Maybe ListVectorEnrichmentJobs #
AWSRequest ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Associated Types type AWSResponse ListVectorEnrichmentJobs # Methods request :: (Service -> Service) -> ListVectorEnrichmentJobs -> Request ListVectorEnrichmentJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListVectorEnrichmentJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListVectorEnrichmentJobs))) #
Generic ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Associated Types type Rep ListVectorEnrichmentJobs :: Type -> Type # Methods from :: ListVectorEnrichmentJobs -> Rep ListVectorEnrichmentJobs x # to :: Rep ListVectorEnrichmentJobs x -> ListVectorEnrichmentJobs #
Show ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods showsPrec :: Int -> ListVectorEnrichmentJobs -> ShowS # show :: ListVectorEnrichmentJobs -> String # showList :: [ListVectorEnrichmentJobs] -> ShowS #
NFData ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods rnf :: ListVectorEnrichmentJobs -> () #
Eq ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods (==) :: ListVectorEnrichmentJobs -> ListVectorEnrichmentJobs -> Bool # (/=) :: ListVectorEnrichmentJobs -> ListVectorEnrichmentJobs -> Bool #
Hashable ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods hashWithSalt :: Int -> ListVectorEnrichmentJobs -> Int # hash :: ListVectorEnrichmentJobs -> Int #
type AWSResponse ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs type AWSResponse ListVectorEnrichmentJobs = ListVectorEnrichmentJobsResponse
type Rep ListVectorEnrichmentJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs type Rep ListVectorEnrichmentJobs = D1 ('MetaData "ListVectorEnrichmentJobs" "Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "ListVectorEnrichmentJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :: S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListVectorEnrichmentJobs :: ListVectorEnrichmentJobs Source #

Create a value of ListVectorEnrichmentJobs 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:ListVectorEnrichmentJobs', listVectorEnrichmentJobs_maxResults - The maximum number of items to return.

ListVectorEnrichmentJobs, listVectorEnrichmentJobs_nextToken - If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

$sel:sortBy:ListVectorEnrichmentJobs', listVectorEnrichmentJobs_sortBy - The parameter by which to sort the results.

$sel:sortOrder:ListVectorEnrichmentJobs', listVectorEnrichmentJobs_sortOrder - An optional value that specifies whether you want the results sorted in Ascending or Descending order.

$sel:statusEquals:ListVectorEnrichmentJobs', listVectorEnrichmentJobs_statusEquals - A filter that retrieves only jobs with a specific status.

Request Lenses

listVectorEnrichmentJobs_maxResults :: Lens' ListVectorEnrichmentJobs (Maybe Natural) Source #

The maximum number of items to return.

listVectorEnrichmentJobs_nextToken :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listVectorEnrichmentJobs_sortBy :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #

The parameter by which to sort the results.

listVectorEnrichmentJobs_sortOrder :: Lens' ListVectorEnrichmentJobs (Maybe SortOrder) Source #

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

listVectorEnrichmentJobs_statusEquals :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #

A filter that retrieves only jobs with a specific status.

Destructuring the Response

data ListVectorEnrichmentJobsResponse Source #

See: newListVectorEnrichmentJobsResponse smart constructor.

Constructors

ListVectorEnrichmentJobsResponse'
Fields nextToken :: Maybe (Sensitive Text) If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. httpStatus :: Int The response's http status code. vectorEnrichmentJobSummaries :: [ListVectorEnrichmentJobOutputConfig] Contains summary information about the Vector Enrichment jobs.

Instances

Instances details

Generic ListVectorEnrichmentJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Associated Types type Rep ListVectorEnrichmentJobsResponse :: Type -> Type # Methods from :: ListVectorEnrichmentJobsResponse -> Rep ListVectorEnrichmentJobsResponse x # to :: Rep ListVectorEnrichmentJobsResponse x -> ListVectorEnrichmentJobsResponse #
Show ListVectorEnrichmentJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods showsPrec :: Int -> ListVectorEnrichmentJobsResponse -> ShowS # show :: ListVectorEnrichmentJobsResponse -> String # showList :: [ListVectorEnrichmentJobsResponse] -> ShowS #
NFData ListVectorEnrichmentJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods rnf :: ListVectorEnrichmentJobsResponse -> () #
Eq ListVectorEnrichmentJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs Methods (==) :: ListVectorEnrichmentJobsResponse -> ListVectorEnrichmentJobsResponse -> Bool # (/=) :: ListVectorEnrichmentJobsResponse -> ListVectorEnrichmentJobsResponse -> Bool #
type Rep ListVectorEnrichmentJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs type Rep ListVectorEnrichmentJobsResponse = D1 ('MetaData "ListVectorEnrichmentJobsResponse" "Amazonka.SageMakerGeoSpatial.ListVectorEnrichmentJobs" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "ListVectorEnrichmentJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "vectorEnrichmentJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListVectorEnrichmentJobOutputConfig]))))

newListVectorEnrichmentJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListVectorEnrichmentJobsResponse'`
-> ListVectorEnrichmentJobsResponse

Create a value of ListVectorEnrichmentJobsResponse 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:

ListVectorEnrichmentJobs, listVectorEnrichmentJobsResponse_nextToken - If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

$sel:httpStatus:ListVectorEnrichmentJobsResponse', listVectorEnrichmentJobsResponse_httpStatus - The response's http status code.

$sel:vectorEnrichmentJobSummaries:ListVectorEnrichmentJobsResponse', listVectorEnrichmentJobsResponse_vectorEnrichmentJobSummaries - Contains summary information about the Vector Enrichment jobs.

Response Lenses

listVectorEnrichmentJobsResponse_nextToken :: Lens' ListVectorEnrichmentJobsResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listVectorEnrichmentJobsResponse_httpStatus :: Lens' ListVectorEnrichmentJobsResponse Int Source #

The response's http status code.

listVectorEnrichmentJobsResponse_vectorEnrichmentJobSummaries :: Lens' ListVectorEnrichmentJobsResponse [ListVectorEnrichmentJobOutputConfig] Source #

Contains summary information about the Vector Enrichment jobs.