SageMakergeospatialcapabilities / Client / get_earth_observation_job

get_earth_observation_job#

SageMakergeospatialcapabilities.Client.get_earth_observation_job(**kwargs)#

Get the details for a previously initiated Earth Observation job.

See also: AWS API Documentation

Request Syntax

response = client.get_earth_observation_job(
    Arn='string'
)
Parameters:

Arn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'DurationInSeconds': 123,
    'ErrorDetails': {
        'Message': 'string',
        'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
    },
    'ExecutionRoleArn': 'string',
    'ExportErrorDetails': {
        'ExportResults': {
            'Message': 'string',
            'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
        },
        'ExportSourceImages': {
            'Message': 'string',
            'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
        }
    },
    'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'InputConfig': {
        'DataSourceConfig': {
            'S3Data': {
                'KmsKeyId': 'string',
                'MetadataProvider': 'PLANET_ORDER',
                'S3Uri': 'string'
            }
        },
        'PreviousEarthObservationJobArn': 'string',
        'RasterDataCollectionQuery': {
            'AreaOfInterest': {
                'AreaOfInterestGeometry': {
                    'MultiPolygonGeometry': {
                        'Coordinates': [
                            [
                                [
                                    [
                                        123.0,
                                    ],
                                ],
                            ],
                        ]
                    },
                    'PolygonGeometry': {
                        'Coordinates': [
                            [
                                [
                                    123.0,
                                ],
                            ],
                        ]
                    }
                }
            },
            'PropertyFilters': {
                'LogicalOperator': 'AND',
                'Properties': [
                    {
                        'Property': {
                            'EoCloudCover': {
                                'LowerBound': ...,
                                'UpperBound': ...
                            },
                            'LandsatCloudCoverLand': {
                                'LowerBound': ...,
                                'UpperBound': ...
                            },
                            'Platform': {
                                'ComparisonOperator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH',
                                'Value': 'string'
                            },
                            'ViewOffNadir': {
                                'LowerBound': ...,
                                'UpperBound': ...
                            },
                            'ViewSunAzimuth': {
                                'LowerBound': ...,
                                'UpperBound': ...
                            },
                            'ViewSunElevation': {
                                'LowerBound': ...,
                                'UpperBound': ...
                            }
                        }
                    },
                ]
            },
            'RasterDataCollectionArn': 'string',
            'RasterDataCollectionName': 'string',
            'TimeRangeFilter': {
                'EndTime': datetime(2015, 1, 1),
                'StartTime': datetime(2015, 1, 1)
            }
        }
    },
    'JobConfig': {
        'BandMathConfig': {
            'CustomIndices': {
                'Operations': [
                    {
                        'Equation': 'string',
                        'Name': 'string',
                        'OutputType': 'INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16'
                    },
                ]
            },
            'PredefinedIndices': [
                'string',
            ]
        },
        'CloudMaskingConfig': {},
        'CloudRemovalConfig': {
            'AlgorithmName': 'INTERPOLATION',
            'InterpolationValue': 'string',
            'TargetBands': [
                'string',
            ]
        },
        'GeoMosaicConfig': {
            'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
            'TargetBands': [
                'string',
            ]
        },
        'LandCoverSegmentationConfig': {},
        'ResamplingConfig': {
            'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
            'OutputResolution': {
                'UserDefined': {
                    'Unit': 'METERS',
                    'Value': ...
                }
            },
            'TargetBands': [
                'string',
            ]
        },
        'StackConfig': {
            'OutputResolution': {
                'Predefined': 'HIGHEST'|'LOWEST'|'AVERAGE',
                'UserDefined': {
                    'Unit': 'METERS',
                    'Value': ...
                }
            },
            'TargetBands': [
                'string',
            ]
        },
        'TemporalStatisticsConfig': {
            'GroupBy': 'ALL'|'YEARLY',
            'Statistics': [
                'MEAN'|'MEDIAN'|'STANDARD_DEVIATION',
            ],
            'TargetBands': [
                'string',
            ]
        },
        'ZonalStatisticsConfig': {
            'Statistics': [
                'MEAN'|'MEDIAN'|'STANDARD_DEVIATION'|'MAX'|'MIN'|'SUM',
            ],
            'TargetBands': [
                'string',
            ],
            'ZoneS3Path': 'string'
        }
    },
    'KmsKeyId': 'string',
    'Name': 'string',
    'OutputBands': [
        {
            'BandName': 'string',
            'OutputDataType': 'INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16'
        },
    ],
    'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • Arn (string) –

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

    • CreationTime (datetime) –

      The creation time of the initiated Earth Observation job.

    • DurationInSeconds (integer) –

      The duration of Earth Observation job, in seconds.

    • ErrorDetails (dict) –

      Details about the errors generated during the Earth Observation job.

      • Message (string) –

      • Type (string) –

    • ExecutionRoleArn (string) –

      The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

    • ExportErrorDetails (dict) –

      Details about the errors generated during ExportEarthObservationJob.

      • ExportResults (dict) –

        • Message (string) –

        • Type (string) –

      • ExportSourceImages (dict) –

        • Message (string) –

        • Type (string) –

    • ExportStatus (string) –

      The status of the Earth Observation job.

    • InputConfig (dict) –

      Input data for the Earth Observation job.

      • DataSourceConfig (dict) –

        The location of the input data.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: S3Data. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • S3Data (dict) –

          • KmsKeyId (string) –

            The Amazon Key Management Service (KMS) key ID for server-side encryption.

          • MetadataProvider (string) –

          • S3Uri (string) –

            The URL to the Amazon S3 input.

      • PreviousEarthObservationJobArn (string) –

        The Amazon Resource Name (ARN) of the previous Earth Observation job.

      • RasterDataCollectionQuery (dict) –

        • AreaOfInterest (dict) – .. note:: This is a Tagged Union structure. Only one of the following top level keys will be set: AreaOfInterestGeometry. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • AreaOfInterestGeometry (dict) – .. note:: This is a Tagged Union structure. Only one of the following top level keys will be set: MultiPolygonGeometry, PolygonGeometry. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • MultiPolygonGeometry (dict) –

              • Coordinates (list) –

                The coordinates of the multipolygon geometry.

                • (list) –

                  • (list) –

                    • (list) –

                      • (float) –

            • PolygonGeometry (dict) –

              • Coordinates (list) –

                • (list) –

                  • (list) –

                    • (float) –

        • PropertyFilters (dict) –

          • LogicalOperator (string) –

          • Properties (list) –

            • (dict) –

              • Property (dict) – .. note:: This is a Tagged Union structure. Only one of the following top level keys will be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • EoCloudCover (dict) –

                  • LowerBound (float) –

                  • UpperBound (float) –

                • LandsatCloudCoverLand (dict) –

                  • LowerBound (float) –

                  • UpperBound (float) –

                • Platform (dict) –

                  • ComparisonOperator (string) –

                  • Value (string) –

                    The value of the platform.

                • ViewOffNadir (dict) –

                  • LowerBound (float) –

                  • UpperBound (float) –

                • ViewSunAzimuth (dict) –

                  • LowerBound (float) –

                  • UpperBound (float) –

                • ViewSunElevation (dict) –

                  • LowerBound (float) –

                    The lower bound to view the sun elevation.

                  • UpperBound (float) –

                    The upper bound to view the sun elevation.

        • RasterDataCollectionArn (string) –

        • RasterDataCollectionName (string) –

          The name of the raster data collection.

        • TimeRangeFilter (dict) –

          • EndTime (datetime) –

            The end time for the time-range filter.

          • StartTime (datetime) –

            The start time for the time-range filter.

    • JobConfig (dict) –

      An object containing information about the job configuration.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: BandMathConfig, CloudMaskingConfig, CloudRemovalConfig, GeoMosaicConfig, LandCoverSegmentationConfig, ResamplingConfig, StackConfig, TemporalStatisticsConfig, ZonalStatisticsConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • BandMathConfig (dict) –

        • CustomIndices (dict) –

          • Operations (list) –

            • (dict) –

              • Equation (string) –

              • Name (string) –

                The name of the operation.

              • OutputType (string) –

                The type of the operation.

        • PredefinedIndices (list) –

          • (string) –

      • CloudMaskingConfig (dict) –

        An object containing information about the job configuration for cloud masking.

      • CloudRemovalConfig (dict) –

        An object containing information about the job configuration for cloud removal.

        • AlgorithmName (string) –

          The name of the algorithm used for cloud removal.

        • InterpolationValue (string) –

          The interpolation value you provide for cloud removal.

        • TargetBands (list) –

          • (string) –

      • GeoMosaicConfig (dict) –

        An object containing information about the job configuration for geomosaic.

        • AlgorithmName (string) –

          The name of the algorithm being used for geomosaic.

        • TargetBands (list) –

          The target bands for geomosaic.

          • (string) –

      • LandCoverSegmentationConfig (dict) –

        An object containing information about the job configuration for land cover segmentation.

      • ResamplingConfig (dict) –

        An object containing information about the job configuration for resampling.

        • AlgorithmName (string) –

          The name of the algorithm used for resampling.

        • OutputResolution (dict) –

          • UserDefined (dict) –

            • Unit (string) –

            • Value (float) –

        • TargetBands (list) –

          • (string) –

      • StackConfig (dict) –

        • OutputResolution (dict) –

          • Predefined (string) –

          • UserDefined (dict) –

            • Unit (string) –

            • Value (float) –

        • TargetBands (list) –

          • (string) –

      • TemporalStatisticsConfig (dict) –

        An object containing information about the job configuration for temporal statistics.

        • GroupBy (string) –

        • Statistics (list) –

          • (string) –

        • TargetBands (list) –

          • (string) –

      • ZonalStatisticsConfig (dict) –

        An object containing information about the job configuration for zonal statistics.

        • Statistics (list) –

          • (string) –

        • TargetBands (list) –

          • (string) –

        • ZoneS3Path (string) –

    • KmsKeyId (string) –

      The Amazon Key Management Service (KMS) key ID for server-side encryption.

    • Name (string) –

      The name of the Earth Observation job.

    • OutputBands (list) –

      • (dict) –

        A single EarthObservationJob output band.

        • BandName (string) –

          The name of the band.

        • OutputDataType (string) –

          The datatype of the output band.

    • Status (string) –

      The status of a previously initiated Earth Observation job.

    • Tags (dict) –

      Each tag consists of a key and a value.

      • (string) –

        • (string) –

Exceptions

  • SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException

  • SageMakergeospatialcapabilities.Client.exceptions.ValidationException

  • SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException

  • SageMakergeospatialcapabilities.Client.exceptions.InternalServerException

  • SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException