SageMakergeospatialcapabilities

Client

class SageMakergeospatialcapabilities.Client

A low-level client representing Amazon SageMaker geospatial capabilities

Provides APIs for creating and managing SageMaker geospatial resources.

client = session.create_client('sagemaker-geospatial')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

delete_earth_observation_job(**kwargs)

Use this operation to delete an Earth Observation job.

See also: AWS API Documentation

Request Syntax

response = client.delete_earth_observation_job(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_vector_enrichment_job(**kwargs)

Use this operation to delete a Vector Enrichment job.

See also: AWS API Documentation

Request Syntax

response = client.delete_vector_enrichment_job(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

export_earth_observation_job(**kwargs)

Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an S3 location.

See also: AWS API Documentation

Request Syntax

response = client.export_earth_observation_job(
    Arn='string',
    ExecutionRoleArn='string',
    ExportSourceImages=True|False,
    OutputConfig={
        'S3Data': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        }
    }
)
Parameters
  • Arn (string) --

    [REQUIRED]

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

  • ExecutionRoleArn (string) --

    [REQUIRED]

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

  • ExportSourceImages (boolean) -- The source images provided to the Earth Observation job being exported.
  • OutputConfig (dict) --

    [REQUIRED]

    An object containing information about the output file.

    • S3Data (dict) -- [REQUIRED]

      Path to Amazon S3 storage location for the output configuration file.

      • KmsKeyId (string) --

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

      • S3Uri (string) -- [REQUIRED]

        The URL to the Amazon S3 data input.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'ExecutionRoleArn': 'string',
    'ExportSourceImages': True|False,
    'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'OutputConfig': {
        'S3Data': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Arn (string) --

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

    • CreationTime (datetime) --

      The creation time.

    • ExecutionRoleArn (string) --

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

    • ExportSourceImages (boolean) --

      The source images provided to the Earth Observation job being exported.

    • ExportStatus (string) --

      The status of the results of the Earth Observation job being exported.

    • OutputConfig (dict) --

      An object containing information about the output file.

      • S3Data (dict) --

        Path to Amazon S3 storage location for the output configuration file.

        • KmsKeyId (string) --

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

        • S3Uri (string) --

          The URL to the Amazon S3 data input.

Exceptions

export_vector_enrichment_job(**kwargs)

Use this operation to copy results of a Vector Enrichment job to an S3 location.

See also: AWS API Documentation

Request Syntax

response = client.export_vector_enrichment_job(
    Arn='string',
    ExecutionRoleArn='string',
    OutputConfig={
        'S3Data': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        }
    }
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Vector Enrichment job.

  • ExecutionRoleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.

  • OutputConfig (dict) --

    [REQUIRED]

    Output location information for exporting Vector Enrichment Job results.

    • S3Data (dict) -- [REQUIRED]
      • KmsKeyId (string) --

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

      • S3Uri (string) -- [REQUIRED]

        The URL to the Amazon S3 data for the Vector Enrichment job.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'ExecutionRoleArn': 'string',
    'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'OutputConfig': {
        'S3Data': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.

    • CreationTime (datetime) --

      The creation time.

    • ExecutionRoleArn (string) --

      The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.

    • ExportStatus (string) --

      The status of the results the Vector Enrichment job being exported.

    • OutputConfig (dict) --

      Output location information for exporting Vector Enrichment Job results.

      • S3Data (dict) --

        • KmsKeyId (string) --

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

        • S3Uri (string) --

          The URL to the Amazon S3 data for the Vector Enrichment job.

Exceptions

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

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_raster_data_collection(**kwargs)

Use this operation to get details of a specific raster data collection.

See also: AWS API Documentation

Request Syntax

response = client.get_raster_data_collection(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the raster data collection.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'Description': 'string',
    'DescriptionPageUrl': 'string',
    'ImageSourceBands': [
        'string',
    ],
    'Name': 'string',
    'SupportedFilters': [
        {
            'Maximum': ...,
            'Minimum': ...,
            'Name': 'string',
            'Type': 'string'
        },
    ],
    'Tags': {
        'string': 'string'
    },
    'Type': 'PUBLIC'|'PREMIUM'|'USER'
}

Response Structure

  • (dict) --
    • Arn (string) --

      The Amazon Resource Name (ARN) of the raster data collection.

    • Description (string) --

      A description of the raster data collection.

    • DescriptionPageUrl (string) --

      The URL of the description page.

    • ImageSourceBands (list) --
      • (string) --
    • Name (string) --

      The name of the raster data collection.

    • SupportedFilters (list) --

      The filters supported by the raster data collection.

      • (dict) --

        The structure representing the filters supported by a RasterDataCollection.

        • Maximum (float) --

          The maximum value of the filter.

        • Minimum (float) --

          The minimum value of the filter.

        • Name (string) --

          The name of the filter.

        • Type (string) --

          The type of the filter being used.

    • Tags (dict) --

      Each tag consists of a key and a value.

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

      The raster data collection type.

Exceptions

get_tile(**kwargs)

Gets a web mercator tile for the given Earth Observation job.

See also: AWS API Documentation

Request Syntax

response = client.get_tile(
    Arn='string',
    ImageAssets=[
        'string',
    ],
    ImageMask=True|False,
    OutputDataType='INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16',
    OutputFormat='string',
    PropertyFilters='string',
    Target='INPUT'|'OUTPUT',
    TimeRangeFilter='string',
    x=123,
    y=123,
    z=123
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the tile operation.

  • ImageAssets (list) --

    [REQUIRED]

    The particular assets or bands to tile.

    • (string) --
  • ImageMask (boolean) -- Determines whether or not to return a valid data mask.
  • OutputDataType (string) -- The output data type of the tile operation.
  • OutputFormat (string) -- The data format of the output tile. The formats include .npy, .png and .jpg.
  • PropertyFilters (string) -- Property filters for the imagery to tile.
  • Target (string) --

    [REQUIRED]

    Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.

  • TimeRangeFilter (string) -- Time range filter applied to imagery to find the images to tile.
  • x (integer) --

    [REQUIRED]

    The x coordinate of the tile input.

  • y (integer) --

    [REQUIRED]

    The y coordinate of the tile input.

  • z (integer) --

    [REQUIRED]

    The z coordinate of the tile input.

Return type

dict

Returns

Response Syntax

{
    'BinaryFile': StreamingBody()
}

Response Structure

  • (dict) --

Exceptions

get_vector_enrichment_job(**kwargs)

Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).

See also: AWS API Documentation

Request Syntax

response = client.get_vector_enrichment_job(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the Vector Enrichment job.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'DurationInSeconds': 123,
    'ErrorDetails': {
        'ErrorMessage': 'string',
        'ErrorType': 'CLIENT_ERROR'|'SERVER_ERROR'
    },
    'ExecutionRoleArn': 'string',
    'ExportErrorDetails': {
        'Message': 'string',
        'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
    },
    'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'InputConfig': {
        'DataSourceConfig': {
            'S3Data': {
                'KmsKeyId': 'string',
                'S3Uri': 'string'
            }
        },
        'DocumentType': 'CSV'
    },
    'JobConfig': {
        'MapMatchingConfig': {
            'IdAttributeName': 'string',
            'TimestampAttributeName': 'string',
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        },
        'ReverseGeocodingConfig': {
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        }
    },
    'KmsKeyId': 'string',
    'Name': 'string',
    'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'STOPPED'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
    'Tags': {
        'string': 'string'
    },
    'Type': 'REVERSE_GEOCODING'|'MAP_MATCHING'
}

Response Structure

  • (dict) --
    • Arn (string) --

      The Amazon Resource Name (ARN) of the Vector Enrichment job.

    • CreationTime (datetime) --

      The creation time.

    • DurationInSeconds (integer) --

      The duration of the Vector Enrichment job, in seconds.

    • ErrorDetails (dict) --

      Details about the errors generated during the Vector Enrichment job.

      • ErrorMessage (string) --

        A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.

      • ErrorType (string) --

        The type of error generated during the Vector Enrichment job.

    • 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 the ExportVectorEnrichmentJob.

      • Message (string) --

        The message providing details about the errors generated during the Vector Enrichment job.

      • Type (string) --
    • ExportStatus (string) --

      The export status of the Vector Enrichment job being initiated.

    • InputConfig (dict) --

      Input configuration information for the Vector Enrichment job.

      • DataSourceConfig (dict) --

        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.

          • S3Uri (string) --

            The URL to the Amazon S3 data for the Vector Enrichment job.

      • DocumentType (string) --
    • 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: MapMatchingConfig, ReverseGeocodingConfig. 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'}
      
      • MapMatchingConfig (dict) --
        • IdAttributeName (string) --
        • TimestampAttributeName (string) --

          The name of the timestamp attribute.

        • XAttributeName (string) --

          The name of the X-attribute

        • YAttributeName (string) --

          The name of the Y-attribute

      • ReverseGeocodingConfig (dict) --
        • XAttributeName (string) --
        • YAttributeName (string) --
    • KmsKeyId (string) --

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

    • Name (string) --

      The name of the Vector Enrichment job.

    • Status (string) --

      The status of the initiated Vector Enrichment job.

    • Tags (dict) --

      Each tag consists of a key and a value.

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

      The type of the Vector Enrichment job being initiated.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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

list_raster_data_collections(**kwargs)

Use this operation to get raster data collections.

See also: AWS API Documentation

Request Syntax

response = client.list_raster_data_collections(
    MaxResults=123,
    NextToken='string'
)
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.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'RasterDataCollectionSummaries': [
        {
            'Arn': 'string',
            'Description': 'string',
            'DescriptionPageUrl': 'string',
            'Name': 'string',
            'SupportedFilters': [
                {
                    'Maximum': ...,
                    'Minimum': ...,
                    'Name': 'string',
                    'Type': 'string'
                },
            ],
            'Tags': {
                'string': 'string'
            },
            'Type': 'PUBLIC'|'PREMIUM'|'USER'
        },
    ]
}

Response Structure

  • (dict) --

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

    • RasterDataCollectionSummaries (list) --

      Contains summary information about the raster data collection.

      • (dict) --

        Response object containing details for a specific RasterDataCollection.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the raster data collection.

        • Description (string) --

          A description of the raster data collection.

        • DescriptionPageUrl (string) --

          The description URL of the raster data collection.

        • Name (string) --

          The name of the raster data collection.

        • SupportedFilters (list) --

          • (dict) --

            The structure representing the filters supported by a RasterDataCollection.

            • Maximum (float) --

              The maximum value of the filter.

            • Minimum (float) --

              The minimum value of the filter.

            • Name (string) --

              The name of the filter.

            • Type (string) --

              The type of the filter being used.

        • Tags (dict) --

          Each tag consists of a key and a value.

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

          The type of raster data collection.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags attached to the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource you want to tag.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      Each tag consists of a key and a value.

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

Exceptions

list_vector_enrichment_jobs(**kwargs)

Retrieves a list of vector enrichment jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_vector_enrichment_jobs(
    MaxResults=123,
    NextToken='string',
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING',
    StatusEquals='string'
)
Parameters
  • MaxResults (integer) -- The maximum 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

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

Response Structure

  • (dict) --

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

    • VectorEnrichmentJobSummaries (list) --

      Contains summary information about the Vector Enrichment jobs.

      • (dict) --

        An object containing information about the output file.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.

        • CreationTime (datetime) --

          The creation time.

        • DurationInSeconds (integer) --

          The duration of the session, in seconds.

        • Name (string) --

          The names of the Vector Enrichment jobs in the list.

        • Status (string) --

          The status of the Vector Enrichment jobs list.

        • Tags (dict) --

          Each tag consists of a key and a value.

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

          The type of the list of Vector Enrichment jobs.

Exceptions

search_raster_data_collection(**kwargs)

Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.

See also: AWS API Documentation

Request Syntax

response = client.search_raster_data_collection(
    Arn='string',
    NextToken='string',
    RasterDataCollectionQuery={
        'AreaOfInterest': {
            'AreaOfInterestGeometry': {
                'MultiPolygonGeometry': {
                    'Coordinates': [
                        [
                            [
                                [
                                    123.0,
                                ],
                            ],
                        ],
                    ]
                },
                'PolygonGeometry': {
                    'Coordinates': [
                        [
                            [
                                123.0,
                            ],
                        ],
                    ]
                }
            }
        },
        'BandFilter': [
            'string',
        ],
        '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': ...
                        }
                    }
                },
            ]
        },
        'TimeRangeFilter': {
            'EndTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1)
        }
    }
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the raster data collection.

  • 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.
  • RasterDataCollectionQuery (dict) --

    [REQUIRED]

    • AreaOfInterest (dict) --

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: AreaOfInterestGeometry.

      • AreaOfInterestGeometry (dict) --

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.

        • MultiPolygonGeometry (dict) --
          • Coordinates (list) -- [REQUIRED]

            The coordinates of the multipolygon geometry.

            • (list) --
              • (list) --
                • (list) --
                  • (float) --
        • PolygonGeometry (dict) --
          • Coordinates (list) -- [REQUIRED]
            • (list) --
              • (list) --
                • (float) --
    • BandFilter (list) --
      • (string) --
    • PropertyFilters (dict) --
      • LogicalOperator (string) --
      • Properties (list) --
        • (dict) --
          • Property (dict) -- [REQUIRED]

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.

            • EoCloudCover (dict) --
              • LowerBound (float) -- [REQUIRED]
              • UpperBound (float) -- [REQUIRED]
            • LandsatCloudCoverLand (dict) --
              • LowerBound (float) -- [REQUIRED]
              • UpperBound (float) -- [REQUIRED]
            • Platform (dict) --
              • ComparisonOperator (string) --
              • Value (string) -- [REQUIRED]

                The value of the platform.

            • ViewOffNadir (dict) --
              • LowerBound (float) -- [REQUIRED]
              • UpperBound (float) -- [REQUIRED]
            • ViewSunAzimuth (dict) --
              • LowerBound (float) -- [REQUIRED]
              • UpperBound (float) -- [REQUIRED]
            • ViewSunElevation (dict) --
              • LowerBound (float) -- [REQUIRED]

                The lower bound to view the sun elevation.

              • UpperBound (float) -- [REQUIRED]

                The upper bound to view the sun elevation.

    • TimeRangeFilter (dict) -- [REQUIRED]
      • EndTime (datetime) -- [REQUIRED]

        The end time for the time-range filter.

      • StartTime (datetime) -- [REQUIRED]

        The start time for the time-range filter.

Return type

dict

Returns

Response Syntax

{
    'ApproximateResultCount': 123,
    'Items': [
        {
            'Assets': {
                'string': {
                    'Href': 'string'
                }
            },
            'DateTime': datetime(2015, 1, 1),
            'Geometry': {
                'Coordinates': [
                    [
                        [
                            123.0,
                        ],
                    ],
                ],
                'Type': 'string'
            },
            'Id': 'string',
            'Properties': {
                'EoCloudCover': ...,
                'LandsatCloudCoverLand': ...,
                'Platform': 'string',
                'ViewOffNadir': ...,
                'ViewSunAzimuth': ...,
                'ViewSunElevation': ...
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ApproximateResultCount (integer) --

    • Items (list) --

      • (dict) --

        Structure representing the items in the response for SearchRasterDataCollection.

        • Assets (dict) --

          • (string) --
            • (dict) --
              • Href (string) --
        • DateTime (datetime) --

        • Geometry (dict) --

          • Coordinates (list) --
            • (list) --
              • (list) --
                • (float) --
          • Type (string) --
        • Id (string) --

          A unique Id for the source item.

        • Properties (dict) --

          • EoCloudCover (float) --
          • LandsatCloudCoverLand (float) --
          • Platform (string) --
          • ViewOffNadir (float) --
          • ViewSunAzimuth (float) --
          • ViewSunElevation (float) --
    • 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

start_earth_observation_job(**kwargs)

Use this operation to create an Earth observation job.

See also: AWS API Documentation

Request Syntax

response = client.start_earth_observation_job(
    ClientToken='string',
    ExecutionRoleArn='string',
    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',
            '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',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientToken (string) --

    A unique token that guarantees that the call to this API is idempotent.

    This field is autopopulated if not provided.

  • ExecutionRoleArn (string) -- The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
  • InputConfig (dict) --

    [REQUIRED]

    Input configuration information 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 can be set: S3Data.

      • S3Data (dict) --
        • KmsKeyId (string) --

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

        • MetadataProvider (string) -- [REQUIRED]
        • S3Uri (string) -- [REQUIRED]

          The URL to the Amazon S3 input.

    • PreviousEarthObservationJobArn (string) --

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

    • RasterDataCollectionQuery (dict) --
      • AreaOfInterest (dict) --

        The area of interest being queried for the raster data collection.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: AreaOfInterestGeometry.

        • AreaOfInterestGeometry (dict) --

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.

          • MultiPolygonGeometry (dict) --
            • Coordinates (list) -- [REQUIRED]

              The coordinates of the multipolygon geometry.

              • (list) --
                • (list) --
                  • (list) --
                    • (float) --
          • PolygonGeometry (dict) --
            • Coordinates (list) -- [REQUIRED]
              • (list) --
                • (list) --
                  • (float) --
      • PropertyFilters (dict) --
        • LogicalOperator (string) --
        • Properties (list) --
          • (dict) --
            • Property (dict) -- [REQUIRED]

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.

              • EoCloudCover (dict) --
                • LowerBound (float) -- [REQUIRED]
                • UpperBound (float) -- [REQUIRED]
              • LandsatCloudCoverLand (dict) --
                • LowerBound (float) -- [REQUIRED]
                • UpperBound (float) -- [REQUIRED]
              • Platform (dict) --
                • ComparisonOperator (string) --
                • Value (string) -- [REQUIRED]

                  The value of the platform.

              • ViewOffNadir (dict) --
                • LowerBound (float) -- [REQUIRED]
                • UpperBound (float) -- [REQUIRED]
              • ViewSunAzimuth (dict) --
                • LowerBound (float) -- [REQUIRED]
                • UpperBound (float) -- [REQUIRED]
              • ViewSunElevation (dict) --
                • LowerBound (float) -- [REQUIRED]

                  The lower bound to view the sun elevation.

                • UpperBound (float) -- [REQUIRED]

                  The upper bound to view the sun elevation.

      • RasterDataCollectionArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the raster data collection.

      • TimeRangeFilter (dict) -- [REQUIRED]
        • EndTime (datetime) -- [REQUIRED]

          The end time for the time-range filter.

        • StartTime (datetime) -- [REQUIRED]

          The start time for the time-range filter.

  • JobConfig (dict) --

    [REQUIRED]

    An object containing information about the job configuration.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: BandMathConfig, CloudMaskingConfig, CloudRemovalConfig, GeoMosaicConfig, LandCoverSegmentationConfig, ResamplingConfig, StackConfig, TemporalStatisticsConfig, ZonalStatisticsConfig.

    • BandMathConfig (dict) --
      • CustomIndices (dict) --
        • Operations (list) --
          • (dict) --
            • Equation (string) -- [REQUIRED]
            • Name (string) -- [REQUIRED]

              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) -- [REQUIRED]
        • UserDefined (dict) -- [REQUIRED]
          • Unit (string) -- [REQUIRED]
          • Value (float) -- [REQUIRED]
      • TargetBands (list) --
        • (string) --
    • StackConfig (dict) --
      • OutputResolution (dict) --
        • Predefined (string) --
        • UserDefined (dict) --
          • Unit (string) -- [REQUIRED]
          • Value (float) -- [REQUIRED]
      • TargetBands (list) --
        • (string) --
    • TemporalStatisticsConfig (dict) --

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

      • GroupBy (string) --
      • Statistics (list) -- [REQUIRED]
        • (string) --
      • TargetBands (list) --
        • (string) --
    • ZonalStatisticsConfig (dict) --

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

      • Statistics (list) -- [REQUIRED]
        • (string) --
      • TargetBands (list) --
        • (string) --
      • ZoneS3Path (string) -- [REQUIRED]
  • KmsKeyId (string) -- The Amazon Key Management Service (KMS) key ID for server-side encryption.
  • Name (string) --

    [REQUIRED]

    The name of the Earth Observation job.

  • Tags (dict) --

    Each tag consists of a key and a value.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'DurationInSeconds': 123,
    'ExecutionRoleArn': 'string',
    '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',
    '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.

    • DurationInSeconds (integer) --

      The duration of the session, in seconds.

    • ExecutionRoleArn (string) --

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

    • InputConfig (dict) --

      Input configuration information 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.

    • Status (string) --

      The status of the Earth Observation job.

    • Tags (dict) --

      Each tag consists of a key and a value.

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

Exceptions

start_vector_enrichment_job(**kwargs)

Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.

See also: AWS API Documentation

Request Syntax

response = client.start_vector_enrichment_job(
    ClientToken='string',
    ExecutionRoleArn='string',
    InputConfig={
        'DataSourceConfig': {
            'S3Data': {
                'KmsKeyId': 'string',
                'S3Uri': 'string'
            }
        },
        'DocumentType': 'CSV'
    },
    JobConfig={
        'MapMatchingConfig': {
            'IdAttributeName': 'string',
            'TimestampAttributeName': 'string',
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        },
        'ReverseGeocodingConfig': {
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        }
    },
    KmsKeyId='string',
    Name='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientToken (string) --

    A unique token that guarantees that the call to this API is idempotent.

    This field is autopopulated if not provided.

  • ExecutionRoleArn (string) --

    [REQUIRED]

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

  • InputConfig (dict) --

    [REQUIRED]

    Input configuration information for the Vector Enrichment job.

    • DataSourceConfig (dict) -- [REQUIRED]

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: S3Data.

      • S3Data (dict) --
        • KmsKeyId (string) --

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

        • S3Uri (string) -- [REQUIRED]

          The URL to the Amazon S3 data for the Vector Enrichment job.

    • DocumentType (string) -- [REQUIRED]
  • JobConfig (dict) --

    [REQUIRED]

    An object containing information about the job configuration.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: MapMatchingConfig, ReverseGeocodingConfig.

    • MapMatchingConfig (dict) --
      • IdAttributeName (string) -- [REQUIRED]
      • TimestampAttributeName (string) -- [REQUIRED]

        The name of the timestamp attribute.

      • XAttributeName (string) -- [REQUIRED]

        The name of the X-attribute

      • YAttributeName (string) -- [REQUIRED]

        The name of the Y-attribute

    • ReverseGeocodingConfig (dict) --
      • XAttributeName (string) -- [REQUIRED]
      • YAttributeName (string) -- [REQUIRED]
  • KmsKeyId (string) -- The Amazon Key Management Service (KMS) key ID for server-side encryption.
  • Name (string) --

    [REQUIRED]

    The name of the Vector Enrichment job.

  • Tags (dict) --

    Each tag consists of a key and a value.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'DurationInSeconds': 123,
    'ExecutionRoleArn': 'string',
    'InputConfig': {
        'DataSourceConfig': {
            'S3Data': {
                'KmsKeyId': 'string',
                'S3Uri': 'string'
            }
        },
        'DocumentType': 'CSV'
    },
    'JobConfig': {
        'MapMatchingConfig': {
            'IdAttributeName': 'string',
            'TimestampAttributeName': 'string',
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        },
        'ReverseGeocodingConfig': {
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        }
    },
    'KmsKeyId': 'string',
    'Name': 'string',
    'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'STOPPED'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
    'Tags': {
        'string': 'string'
    },
    'Type': 'REVERSE_GEOCODING'|'MAP_MATCHING'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the Vector Enrichment job.

    • CreationTime (datetime) --

      The creation time.

    • DurationInSeconds (integer) --

      The duration of the Vector Enrichment job, in seconds.

    • ExecutionRoleArn (string) --

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

    • InputConfig (dict) --

      Input configuration information for starting the Vector Enrichment job.

      • DataSourceConfig (dict) --

        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.

          • S3Uri (string) --

            The URL to the Amazon S3 data for the Vector Enrichment job.

      • DocumentType (string) --

    • 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: MapMatchingConfig, ReverseGeocodingConfig. 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'}
      
      • MapMatchingConfig (dict) --

        • IdAttributeName (string) --

        • TimestampAttributeName (string) --

          The name of the timestamp attribute.

        • XAttributeName (string) --

          The name of the X-attribute

        • YAttributeName (string) --

          The name of the Y-attribute

      • ReverseGeocodingConfig (dict) --

        • XAttributeName (string) --
        • YAttributeName (string) --
    • KmsKeyId (string) --

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

    • Name (string) --

      The name of the Vector Enrichment job.

    • Status (string) --

      The status of the Vector Enrichment job being started.

    • Tags (dict) --

      Each tag consists of a key and a value.

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

      The type of the Vector Enrichment job.

Exceptions

stop_earth_observation_job(**kwargs)

Use this operation to stop an existing earth observation job.

See also: AWS API Documentation

Request Syntax

response = client.stop_earth_observation_job(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

stop_vector_enrichment_job(**kwargs)

Stops the Vector Enrichment job for a given job ARN.

See also: AWS API Documentation

Request Syntax

response = client.stop_vector_enrichment_job(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the Vector Enrichment job.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

The resource you want to tag.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource you want to tag.

  • Tags (dict) --

    [REQUIRED]

    Each tag consists of a key and a value.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

The resource you want to untag.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource you want to untag.

  • TagKeys (list) --

    [REQUIRED]

    Keys of the tags you want to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SageMakergeospatialcapabilities.Client.exceptions.ConflictException

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • ResourceId (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SageMakergeospatialcapabilities.Client.exceptions.InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception, or failure.

    • Message (string) --
    • ResourceId (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • ResourceId (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededException

You have exceeded the service quota.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You have exceeded the service quota.

    • Message (string) --
    • ResourceId (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • Message (string) --
    • ResourceId (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SageMakergeospatialcapabilities.Client.exceptions.ValidationException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy the constraints specified by an Amazon Web Services service.

    • Message (string) --
    • ResourceId (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class SageMakergeospatialcapabilities.Paginator.ListEarthObservationJobs
paginator = client.get_paginator('list_earth_observation_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMakergeospatialcapabilities.Client.list_earth_observation_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING',
    StatusEquals='INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

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'
            }
        },
    ],

}

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) --

class SageMakergeospatialcapabilities.Paginator.ListRasterDataCollections
paginator = client.get_paginator('list_raster_data_collections')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMakergeospatialcapabilities.Client.list_raster_data_collections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'RasterDataCollectionSummaries': [
        {
            'Arn': 'string',
            'Description': 'string',
            'DescriptionPageUrl': 'string',
            'Name': 'string',
            'SupportedFilters': [
                {
                    'Maximum': ...,
                    'Minimum': ...,
                    'Name': 'string',
                    'Type': 'string'
                },
            ],
            'Tags': {
                'string': 'string'
            },
            'Type': 'PUBLIC'|'PREMIUM'|'USER'
        },
    ]
}

Response Structure

  • (dict) --
    • RasterDataCollectionSummaries (list) --

      Contains summary information about the raster data collection.

      • (dict) --

        Response object containing details for a specific RasterDataCollection.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the raster data collection.

        • Description (string) --

          A description of the raster data collection.

        • DescriptionPageUrl (string) --

          The description URL of the raster data collection.

        • Name (string) --

          The name of the raster data collection.

        • SupportedFilters (list) --
          • (dict) --

            The structure representing the filters supported by a RasterDataCollection.

            • Maximum (float) --

              The maximum value of the filter.

            • Minimum (float) --

              The minimum value of the filter.

            • Name (string) --

              The name of the filter.

            • Type (string) --

              The type of the filter being used.

        • Tags (dict) --

          Each tag consists of a key and a value.

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

          The type of raster data collection.

class SageMakergeospatialcapabilities.Paginator.ListVectorEnrichmentJobs
paginator = client.get_paginator('list_vector_enrichment_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMakergeospatialcapabilities.Client.list_vector_enrichment_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING',
    StatusEquals='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • VectorEnrichmentJobSummaries (list) --

      Contains summary information about the Vector Enrichment jobs.

      • (dict) --

        An object containing information about the output file.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.

        • CreationTime (datetime) --

          The creation time.

        • DurationInSeconds (integer) --

          The duration of the session, in seconds.

        • Name (string) --

          The names of the Vector Enrichment jobs in the list.

        • Status (string) --

          The status of the Vector Enrichment jobs list.

        • Tags (dict) --

          Each tag consists of a key and a value.

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

          The type of the list of Vector Enrichment jobs.