list_earth_observation_jobs

SageMakergeospatialcapabilities.Client.list_earth_observation_jobs(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_earth_observation_jobs(
    MaxResults=123,
    NextToken='string',
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING',
    StatusEquals='INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'
)

Parameters

• MaxResults (integer) -- The total number of items to return.
• NextToken (string) -- If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
• SortBy (string) -- The parameter by which to sort the results.
• SortOrder (string) -- An optional value that specifies whether you want the results sorted in Ascending or Descending order.
• StatusEquals (string) -- A filter that retrieves only jobs with a specific status.

Return type

dict

Returns

Response Syntax

{
    'EarthObservationJobSummaries': [
        {
            'Arn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'DurationInSeconds': 123,
            'Name': 'string',
            'OperationType': 'string',
            'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • EarthObservationJobSummaries (list) --

    Contains summary information about the Earth Observation jobs.

    • (dict) --

      An object containing information about the output file.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.

      • CreationTime (datetime) --

        The creation time.

      • DurationInSeconds (integer) --

        The duration of the session, in seconds.

      • Name (string) --

        The names of the Earth Observation jobs in the list.

      • OperationType (string) --

      • Status (string) --

        The status of the list of the Earth Observation jobs.

      • Tags (dict) --

        Each tag consists of a key and a value.

        • (string) --
          • (string) --

  • NextToken (string) --

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

Exceptions

• SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException
• SageMakergeospatialcapabilities.Client.exceptions.ValidationException
• SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException
• SageMakergeospatialcapabilities.Client.exceptions.InternalServerException
• SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException