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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEarthObservationJobs Source #

See: newListEarthObservationJobs smart constructor.

Constructors

ListEarthObservationJobs'

Fields

maxResults :: Maybe Natural
The total 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 EarthObservationJobStatus
A filter that retrieves only jobs with a specific status.

Instances

Instances details

ToJSON ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods toJSON :: ListEarthObservationJobs -> Value # toEncoding :: ListEarthObservationJobs -> Encoding # toJSONList :: [ListEarthObservationJobs] -> Value # toEncodingList :: [ListEarthObservationJobs] -> Encoding #
ToHeaders ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods toHeaders :: ListEarthObservationJobs -> [Header] #
ToPath ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods toPath :: ListEarthObservationJobs -> ByteString #
ToQuery ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods toQuery :: ListEarthObservationJobs -> QueryString #
AWSPager ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods page :: ListEarthObservationJobs -> AWSResponse ListEarthObservationJobs -> Maybe ListEarthObservationJobs #
AWSRequest ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Associated Types type AWSResponse ListEarthObservationJobs # Methods request :: (Service -> Service) -> ListEarthObservationJobs -> Request ListEarthObservationJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListEarthObservationJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListEarthObservationJobs))) #
Generic ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Associated Types type Rep ListEarthObservationJobs :: Type -> Type # Methods from :: ListEarthObservationJobs -> Rep ListEarthObservationJobs x # to :: Rep ListEarthObservationJobs x -> ListEarthObservationJobs #
Show ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods showsPrec :: Int -> ListEarthObservationJobs -> ShowS # show :: ListEarthObservationJobs -> String # showList :: [ListEarthObservationJobs] -> ShowS #
NFData ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods rnf :: ListEarthObservationJobs -> () #
Eq ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods (==) :: ListEarthObservationJobs -> ListEarthObservationJobs -> Bool # (/=) :: ListEarthObservationJobs -> ListEarthObservationJobs -> Bool #
Hashable ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods hashWithSalt :: Int -> ListEarthObservationJobs -> Int # hash :: ListEarthObservationJobs -> Int #
type AWSResponse ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs type AWSResponse ListEarthObservationJobs = ListEarthObservationJobsResponse
type Rep ListEarthObservationJobs Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs type Rep ListEarthObservationJobs = D1 ('MetaData "ListEarthObservationJobs" "Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "ListEarthObservationJobs'" '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 EarthObservationJobStatus))))))

newListEarthObservationJobs :: ListEarthObservationJobs Source #

Create a value of ListEarthObservationJobs 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:ListEarthObservationJobs', listEarthObservationJobs_maxResults - The total number of items to return.

ListEarthObservationJobs, listEarthObservationJobs_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:ListEarthObservationJobs', listEarthObservationJobs_sortBy - The parameter by which to sort the results.

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

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

Request Lenses

listEarthObservationJobs_maxResults :: Lens' ListEarthObservationJobs (Maybe Natural) Source #

The total number of items to return.

listEarthObservationJobs_nextToken :: Lens' ListEarthObservationJobs (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.

listEarthObservationJobs_sortBy :: Lens' ListEarthObservationJobs (Maybe Text) Source #

The parameter by which to sort the results.

listEarthObservationJobs_sortOrder :: Lens' ListEarthObservationJobs (Maybe SortOrder) Source #

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

listEarthObservationJobs_statusEquals :: Lens' ListEarthObservationJobs (Maybe EarthObservationJobStatus) Source #

A filter that retrieves only jobs with a specific status.

Destructuring the Response

data ListEarthObservationJobsResponse Source #

See: newListEarthObservationJobsResponse smart constructor.

Constructors

ListEarthObservationJobsResponse'
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. earthObservationJobSummaries :: [ListEarthObservationJobOutputConfig] Contains summary information about the Earth Observation jobs.

Instances

Instances details

Generic ListEarthObservationJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Associated Types type Rep ListEarthObservationJobsResponse :: Type -> Type # Methods from :: ListEarthObservationJobsResponse -> Rep ListEarthObservationJobsResponse x # to :: Rep ListEarthObservationJobsResponse x -> ListEarthObservationJobsResponse #
Show ListEarthObservationJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods showsPrec :: Int -> ListEarthObservationJobsResponse -> ShowS # show :: ListEarthObservationJobsResponse -> String # showList :: [ListEarthObservationJobsResponse] -> ShowS #
NFData ListEarthObservationJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods rnf :: ListEarthObservationJobsResponse -> () #
Eq ListEarthObservationJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs Methods (==) :: ListEarthObservationJobsResponse -> ListEarthObservationJobsResponse -> Bool # (/=) :: ListEarthObservationJobsResponse -> ListEarthObservationJobsResponse -> Bool #
type Rep ListEarthObservationJobsResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs type Rep ListEarthObservationJobsResponse = D1 ('MetaData "ListEarthObservationJobsResponse" "Amazonka.SageMakerGeoSpatial.ListEarthObservationJobs" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "ListEarthObservationJobsResponse'" '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 "earthObservationJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListEarthObservationJobOutputConfig]))))

newListEarthObservationJobsResponse Source #

Arguments

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

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

ListEarthObservationJobs, listEarthObservationJobsResponse_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:ListEarthObservationJobsResponse', listEarthObservationJobsResponse_httpStatus - The response's http status code.

$sel:earthObservationJobSummaries:ListEarthObservationJobsResponse', listEarthObservationJobsResponse_earthObservationJobSummaries - Contains summary information about the Earth Observation jobs.

Response Lenses

listEarthObservationJobsResponse_nextToken :: Lens' ListEarthObservationJobsResponse (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.

listEarthObservationJobsResponse_httpStatus :: Lens' ListEarthObservationJobsResponse Int Source #

The response's http status code.

listEarthObservationJobsResponse_earthObservationJobSummaries :: Lens' ListEarthObservationJobsResponse [ListEarthObservationJobOutputConfig] Source #

Contains summary information about the Earth Observation jobs.