SageMakergeospatialcapabilities ******************************* Client ====== class SageMakergeospatialcapabilities.Client A low-level client representing Amazon SageMaker geospatial capabilities Provides APIs for creating and managing SageMaker geospatial resources. import boto3 client = boto3.client('sagemaker-geospatial') These are the available methods: * can_paginate * close * delete_earth_observation_job * delete_vector_enrichment_job * export_earth_observation_job * export_vector_enrichment_job * get_earth_observation_job * get_paginator * get_raster_data_collection * get_tile * get_vector_enrichment_job * get_waiter * list_earth_observation_jobs * list_raster_data_collections * list_tags_for_resource * list_vector_enrichment_jobs * search_raster_data_collection * start_earth_observation_job * start_vector_enrichment_job * stop_earth_observation_job * stop_vector_enrichment_job * tag_resource * untag_resource Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListEarthObservationJobs * ListRasterDataCollections * ListVectorEnrichmentJobs SageMakergeospatialcapabilities / Paginator / ListVectorEnrichmentJobs ListVectorEnrichmentJobs ************************ 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_j obs()". 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. SageMakergeospatialcapabilities / Paginator / ListEarthObservationJobs ListEarthObservationJobs ************************ 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_j obs()". 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) --* The operation type for an Earth Observation job. * **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) --* SageMakergeospatialcapabilities / Paginator / ListRasterDataCollections ListRasterDataCollections ************************* 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_collect ions()". 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) --* The list of 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 type of raster data collection. SageMakergeospatialcapabilities / Client / get_raster_data_collection get_raster_data_collection ************************** SageMakergeospatialcapabilities.Client.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) --* The list of image source bands in the raster data collection. * *(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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / get_paginator get_paginator ************* SageMakergeospatialcapabilities.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. SageMakergeospatialcapabilities / Client / list_raster_data_collections list_raster_data_collections **************************** SageMakergeospatialcapabilities.Client.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) --* The list of 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 type of raster data collection. **Exceptions** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / export_vector_enrichment_job export_vector_enrichment_job **************************** SageMakergeospatialcapabilities.Client.export_vector_enrichment_job(**kwargs) Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location. See also: AWS API Documentation **Request Syntax** response = client.export_vector_enrichment_job( Arn='string', ClientToken='string', ExecutionRoleArn='string', OutputConfig={ 'S3Data': { 'KmsKeyId': 'string', 'S3Uri': 'string' } } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Vector Enrichment job. * **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 rolewith permission to upload to the location in OutputConfig. * **OutputConfig** (*dict*) -- **[REQUIRED]** Output location information for exporting Vector Enrichment Job results. * **S3Data** *(dict) --* **[REQUIRED]** The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects. * **KmsKeyId** *(string) --* The Key Management Service 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) --* The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects. * **KmsKeyId** *(string) --* The Key Management Service key ID for server-side encryption. * **S3Uri** *(string) --* The URL to the Amazon S3 data for the Vector Enrichment job. **Exceptions** * "SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaE xceededException" * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / delete_vector_enrichment_job delete_vector_enrichment_job **************************** SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / stop_vector_enrichment_job stop_vector_enrichment_job ************************** SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / can_paginate can_paginate ************ SageMakergeospatialcapabilities.Client.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. SageMakergeospatialcapabilities / Client / get_earth_observation_job get_earth_observation_job ************************* SageMakergeospatialcapabilities.Client.get_earth_observation_job(**kwargs) Get the details for a previously initiated Earth Observation job. See also: AWS API Documentation **Request Syntax** response = client.get_earth_observation_job( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Earth Observation job. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'DurationInSeconds': 123, 'ErrorDetails': { 'Message': 'string', 'Type': 'CLIENT_ERROR'|'SERVER_ERROR' }, 'ExecutionRoleArn': 'string', 'ExportErrorDetails': { 'ExportResults': { 'Message': 'string', 'Type': 'CLIENT_ERROR'|'SERVER_ERROR' }, 'ExportSourceImages': { 'Message': 'string', 'Type': 'CLIENT_ERROR'|'SERVER_ERROR' } }, 'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED', 'InputConfig': { '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', 'ZoneS3PathKmsKeyId': '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) --* A detailed message describing the error in an Earth Observation job. * **Type** *(string) --* The type of error in an Earth Observation 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 ExportEarthObservationJob. * **ExportResults** *(dict) --* The structure for returning the export error details while exporting results of an Earth Observation job. * **Message** *(string) --* A detailed message describing the error in an export EarthObservationJob operation. * **Type** *(string) --* The type of error in an export EarthObservationJob operation. * **ExportSourceImages** *(dict) --* The structure for returning the export error details while exporting the source images of an Earth Observation job. * **Message** *(string) --* A detailed message describing the error in an export EarthObservationJob operation. * **Type** *(string) --* The type of error in an export EarthObservationJob operation. * **ExportStatus** *(string) --* The status of the Earth Observation job. * **InputConfig** *(dict) --* Input data for the Earth Observation job. * **PreviousEarthObservationJobArn** *(string) --* The Amazon Resource Name (ARN) of the previous Earth Observation job. * **RasterDataCollectionQuery** *(dict) --* The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters. * **AreaOfInterest** *(dict) --* The Area of Interest used in the search. 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) --* A GeoJSON object representing the geographic extent in the coordinate space. 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) --* The structure representing the MultiPolygon Geometry. * **Coordinates** *(list) --* The coordinates of the multipolygon geometry. * *(list) --* * *(list) --* * *(list) --* * *(float) --* * **PolygonGeometry** *(dict) --* The structure representing Polygon Geometry. * **Coordinates** *(list) --* Coordinates representing a Polygon based on the GeoJson spec. * *(list) --* * *(list) --* * *(float) --* * **PropertyFilters** *(dict) --* Property filters used in the search. * **LogicalOperator** *(string) --* The Logical Operator used to combine the Property Filters. * **Properties** *(list) --* A list of Property Filters. * *(dict) --* The structure representing a single PropertyFilter. * **Property** *(dict) --* Represents a single property to match with when searching a raster data collection. 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) --* The structure representing EoCloudCover property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* Lower bound for EoCloudCover. * **UpperBound** *(float) --* Upper bound for EoCloudCover. * **LandsatCloudCoverLand** *(dict) --* The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound. * **LowerBound** *(float) --* The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value. * **UpperBound** *(float) --* The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value. * **Platform** *(dict) --* The structure representing Platform property filter consisting of value and comparison operator. * **ComparisonOperator** *(string) --* The ComparisonOperator to use with PlatformInput. * **Value** *(string) --* The value of the platform. * **ViewOffNadir** *(dict) --* The structure representing ViewOffNadir property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value. * **UpperBound** *(float) --* The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value. * **ViewSunAzimuth** *(dict) --* The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value. * **UpperBound** *(float) --* The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value. * **ViewSunElevation** *(dict) --* The structure representing ViewSunElevation property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* The lower bound to view the sun elevation. * **UpperBound** *(float) --* The upper bound to view the sun elevation. * **RasterDataCollectionArn** *(string) --* The ARN of the Raster Data Collection against which the search is done. * **RasterDataCollectionName** *(string) --* The name of the raster data collection. * **TimeRangeFilter** *(dict) --* The TimeRange filter used in the search. * **EndTime** *(datetime) --* The ending time for the time range filter. * **StartTime** *(datetime) --* The starting 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) --* An object containing information about the job configuration for BandMath. * **CustomIndices** *(dict) --* CustomIndices that are computed. * **Operations** *(list) --* A list of BandMath indices to compute. * *(dict) --* Represents an arithmetic operation to compute spectral index. * **Equation** *(string) --* Textual representation of the math operation; Equation used to compute the spectral index. * **Name** *(string) --* The name of the operation. * **OutputType** *(string) --* The type of the operation. * **PredefinedIndices** *(list) --* One or many of the supported predefined indices to compute. Allowed values: "NDVI", "EVI2", "MSAVI", "NDWI", "NDMI", "NDSI", and "WDRVI". * *(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) --* TargetBands to be returned in the output of CloudRemoval operation. * *(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) --* The structure representing output resolution (in target georeferenced units) of the result of resampling operation. * **UserDefined** *(dict) --* User Defined Resolution for the output of Resampling operation defined by value and unit. * **Unit** *(string) --* The units for output resolution of the result. * **Value** *(float) --* The value for output resolution of the result. * **TargetBands** *(list) --* Bands used in the operation. If no target bands are specified, it uses all bands available in the input. * *(string) --* * **StackConfig** *(dict) --* An object containing information about the job configuration for a Stacking Earth Observation job. * **OutputResolution** *(dict) --* The structure representing output resolution (in target georeferenced units) of the result of stacking operation. * **Predefined** *(string) --* A string value representing Predefined Output Resolution for a stacking operation. Allowed values are "HIGHEST", "LOWEST", and "AVERAGE". * **UserDefined** *(dict) --* The structure representing User Output Resolution for a Stacking operation defined as a value and unit. * **Unit** *(string) --* The units for output resolution of the result. * **Value** *(float) --* The value for output resolution of the result. * **TargetBands** *(list) --* A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names. * *(string) --* * **TemporalStatisticsConfig** *(dict) --* An object containing information about the job configuration for temporal statistics. * **GroupBy** *(string) --* The input for the temporal statistics grouping by time frequency option. * **Statistics** *(list) --* The list of the statistics method options. * *(string) --* * **TargetBands** *(list) --* The list of target band names for the temporal statistic to calculate. * *(string) --* * **ZonalStatisticsConfig** *(dict) --* An object containing information about the job configuration for zonal statistics. * **Statistics** *(list) --* List of zonal statistics to compute. * *(string) --* * **TargetBands** *(list) --* Bands used in the operation. If no target bands are specified, it uses all bands available input. * *(string) --* * **ZoneS3Path** *(string) --* The Amazon S3 path pointing to the GeoJSON containing the polygonal zones. * **ZoneS3PathKmsKeyId** *(string) --* The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have "kms:GenerateDataKey" permission. The "KmsKeyId" can be any of the following formats: * // KMS Key ID ""1234abcd-12ab-34cd-56ef-1234567890ab"" * // Amazon Resource Name (ARN) of a KMS Key ""arn:aws:kms:::key/"" For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation. * **KmsKeyId** *(string) --* The Key Management Service key ID for server-side encryption. * **Name** *(string) --* The name of the Earth Observation job. * **OutputBands** *(list) --* Bands available in the output of an operation. * *(dict) --* A single EarthObservationJob output band. * **BandName** *(string) --* The name of the band. * **OutputDataType** *(string) --* The datatype of the output band. * **Status** *(string) --* The status of a previously initiated Earth Observation job. * **Tags** *(dict) --* Each tag consists of a key and a value. * *(string) --* * *(string) --* **Exceptions** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / list_tags_for_resource list_tags_for_resource ********************** SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / untag_resource untag_resource ************** SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / get_waiter get_waiter ********** SageMakergeospatialcapabilities.Client.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" SageMakergeospatialcapabilities / Client / get_tile get_tile ******** SageMakergeospatialcapabilities.Client.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', ExecutionRoleArn='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. * **ExecutionRoleArn** (*string*) -- The Amazon Resource Name (ARN) of the IAM role that you specify. * **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) --* * **BinaryFile** ("StreamingBody") -- The output binary file. **Exceptions** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / start_earth_observation_job start_earth_observation_job *************************** SageMakergeospatialcapabilities.Client.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={ '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', 'ZoneS3PathKmsKeyId': '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 Earth Observation job. * **PreviousEarthObservationJobArn** *(string) --* The Amazon Resource Name (ARN) of the previous Earth Observation job. * **RasterDataCollectionQuery** *(dict) --* The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters. * **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) --* A GeoJSON object representing the geographic extent in the coordinate space. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "MultiPolygonGeometry", "PolygonGeometry". * **MultiPolygonGeometry** *(dict) --* The structure representing the MultiPolygon Geometry. * **Coordinates** *(list) --* **[REQUIRED]** The coordinates of the multipolygon geometry. * *(list) --* * *(list) --* * *(list) --* * *(float) --* * **PolygonGeometry** *(dict) --* The structure representing Polygon Geometry. * **Coordinates** *(list) --* **[REQUIRED]** Coordinates representing a Polygon based on the GeoJson spec. * *(list) --* * *(list) --* * *(float) --* * **PropertyFilters** *(dict) --* The list of Property filters used in the Raster Data Collection Query. * **LogicalOperator** *(string) --* The Logical Operator used to combine the Property Filters. * **Properties** *(list) --* A list of Property Filters. * *(dict) --* The structure representing a single PropertyFilter. * **Property** *(dict) --* **[REQUIRED]** Represents a single property to match with when searching a raster data collection. 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) --* The structure representing EoCloudCover property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** Lower bound for EoCloudCover. * **UpperBound** *(float) --* **[REQUIRED]** Upper bound for EoCloudCover. * **LandsatCloudCoverLand** *(dict) --* The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value. * **UpperBound** *(float) --* **[REQUIRED]** The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value. * **Platform** *(dict) --* The structure representing Platform property filter consisting of value and comparison operator. * **ComparisonOperator** *(string) --* The ComparisonOperator to use with PlatformInput. * **Value** *(string) --* **[REQUIRED]** The value of the platform. * **ViewOffNadir** *(dict) --* The structure representing ViewOffNadir property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value. * **UpperBound** *(float) --* **[REQUIRED]** The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value. * **ViewSunAzimuth** *(dict) --* The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value. * **UpperBound** *(float) --* **[REQUIRED]** The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value. * **ViewSunElevation** *(dict) --* The structure representing ViewSunElevation property filter containing a lower bound and upper bound. * **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]** The TimeRange Filter used in the RasterDataCollection Query. * **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) --* An object containing information about the job configuration for BandMath. * **CustomIndices** *(dict) --* CustomIndices that are computed. * **Operations** *(list) --* A list of BandMath indices to compute. * *(dict) --* Represents an arithmetic operation to compute spectral index. * **Equation** *(string) --* **[REQUIRED]** Textual representation of the math operation; Equation used to compute the spectral index. * **Name** *(string) --* **[REQUIRED]** The name of the operation. * **OutputType** *(string) --* The type of the operation. * **PredefinedIndices** *(list) --* One or many of the supported predefined indices to compute. Allowed values: "NDVI", "EVI2", "MSAVI", "NDWI", "NDMI", "NDSI", and "WDRVI". * *(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) --* TargetBands to be returned in the output of CloudRemoval operation. * *(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]** The structure representing output resolution (in target georeferenced units) of the result of resampling operation. * **UserDefined** *(dict) --* **[REQUIRED]** User Defined Resolution for the output of Resampling operation defined by value and unit. * **Unit** *(string) --* **[REQUIRED]** The units for output resolution of the result. * **Value** *(float) --* **[REQUIRED]** The value for output resolution of the result. * **TargetBands** *(list) --* Bands used in the operation. If no target bands are specified, it uses all bands available in the input. * *(string) --* * **StackConfig** *(dict) --* An object containing information about the job configuration for a Stacking Earth Observation job. * **OutputResolution** *(dict) --* The structure representing output resolution (in target georeferenced units) of the result of stacking operation. * **Predefined** *(string) --* A string value representing Predefined Output Resolution for a stacking operation. Allowed values are "HIGHEST", "LOWEST", and "AVERAGE". * **UserDefined** *(dict) --* The structure representing User Output Resolution for a Stacking operation defined as a value and unit. * **Unit** *(string) --* **[REQUIRED]** The units for output resolution of the result. * **Value** *(float) --* **[REQUIRED]** The value for output resolution of the result. * **TargetBands** *(list) --* A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names. * *(string) --* * **TemporalStatisticsConfig** *(dict) --* An object containing information about the job configuration for temporal statistics. * **GroupBy** *(string) --* The input for the temporal statistics grouping by time frequency option. * **Statistics** *(list) --* **[REQUIRED]** The list of the statistics method options. * *(string) --* * **TargetBands** *(list) --* The list of target band names for the temporal statistic to calculate. * *(string) --* * **ZonalStatisticsConfig** *(dict) --* An object containing information about the job configuration for zonal statistics. * **Statistics** *(list) --* **[REQUIRED]** List of zonal statistics to compute. * *(string) --* * **TargetBands** *(list) --* Bands used in the operation. If no target bands are specified, it uses all bands available input. * *(string) --* * **ZoneS3Path** *(string) --* **[REQUIRED]** The Amazon S3 path pointing to the GeoJSON containing the polygonal zones. * **ZoneS3PathKmsKeyId** *(string) --* The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have "kms:GenerateDataKey" permission. The "KmsKeyId" can be any of the following formats: * // KMS Key ID ""1234abcd-12ab-34cd-56ef-1234567890ab"" * // Amazon Resource Name (ARN) of a KMS Key ""arn:aws:kms:::key/"" For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation. * **KmsKeyId** (*string*) -- The Key Management Service 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': { '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', 'ZoneS3PathKmsKeyId': '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. * **PreviousEarthObservationJobArn** *(string) --* The Amazon Resource Name (ARN) of the previous Earth Observation job. * **RasterDataCollectionQuery** *(dict) --* The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters. * **AreaOfInterest** *(dict) --* The Area of Interest used in the search. 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) --* A GeoJSON object representing the geographic extent in the coordinate space. 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) --* The structure representing the MultiPolygon Geometry. * **Coordinates** *(list) --* The coordinates of the multipolygon geometry. * *(list) --* * *(list) --* * *(list) --* * *(float) --* * **PolygonGeometry** *(dict) --* The structure representing Polygon Geometry. * **Coordinates** *(list) --* Coordinates representing a Polygon based on the GeoJson spec. * *(list) --* * *(list) --* * *(float) --* * **PropertyFilters** *(dict) --* Property filters used in the search. * **LogicalOperator** *(string) --* The Logical Operator used to combine the Property Filters. * **Properties** *(list) --* A list of Property Filters. * *(dict) --* The structure representing a single PropertyFilter. * **Property** *(dict) --* Represents a single property to match with when searching a raster data collection. 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) --* The structure representing EoCloudCover property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* Lower bound for EoCloudCover. * **UpperBound** *(float) --* Upper bound for EoCloudCover. * **LandsatCloudCoverLand** *(dict) --* The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound. * **LowerBound** *(float) --* The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value. * **UpperBound** *(float) --* The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value. * **Platform** *(dict) --* The structure representing Platform property filter consisting of value and comparison operator. * **ComparisonOperator** *(string) --* The ComparisonOperator to use with PlatformInput. * **Value** *(string) --* The value of the platform. * **ViewOffNadir** *(dict) --* The structure representing ViewOffNadir property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value. * **UpperBound** *(float) --* The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value. * **ViewSunAzimuth** *(dict) --* The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value. * **UpperBound** *(float) --* The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value. * **ViewSunElevation** *(dict) --* The structure representing ViewSunElevation property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* The lower bound to view the sun elevation. * **UpperBound** *(float) --* The upper bound to view the sun elevation. * **RasterDataCollectionArn** *(string) --* The ARN of the Raster Data Collection against which the search is done. * **RasterDataCollectionName** *(string) --* The name of the raster data collection. * **TimeRangeFilter** *(dict) --* The TimeRange filter used in the search. * **EndTime** *(datetime) --* The ending time for the time range filter. * **StartTime** *(datetime) --* The starting 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) --* An object containing information about the job configuration for BandMath. * **CustomIndices** *(dict) --* CustomIndices that are computed. * **Operations** *(list) --* A list of BandMath indices to compute. * *(dict) --* Represents an arithmetic operation to compute spectral index. * **Equation** *(string) --* Textual representation of the math operation; Equation used to compute the spectral index. * **Name** *(string) --* The name of the operation. * **OutputType** *(string) --* The type of the operation. * **PredefinedIndices** *(list) --* One or many of the supported predefined indices to compute. Allowed values: "NDVI", "EVI2", "MSAVI", "NDWI", "NDMI", "NDSI", and "WDRVI". * *(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) --* TargetBands to be returned in the output of CloudRemoval operation. * *(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) --* The structure representing output resolution (in target georeferenced units) of the result of resampling operation. * **UserDefined** *(dict) --* User Defined Resolution for the output of Resampling operation defined by value and unit. * **Unit** *(string) --* The units for output resolution of the result. * **Value** *(float) --* The value for output resolution of the result. * **TargetBands** *(list) --* Bands used in the operation. If no target bands are specified, it uses all bands available in the input. * *(string) --* * **StackConfig** *(dict) --* An object containing information about the job configuration for a Stacking Earth Observation job. * **OutputResolution** *(dict) --* The structure representing output resolution (in target georeferenced units) of the result of stacking operation. * **Predefined** *(string) --* A string value representing Predefined Output Resolution for a stacking operation. Allowed values are "HIGHEST", "LOWEST", and "AVERAGE". * **UserDefined** *(dict) --* The structure representing User Output Resolution for a Stacking operation defined as a value and unit. * **Unit** *(string) --* The units for output resolution of the result. * **Value** *(float) --* The value for output resolution of the result. * **TargetBands** *(list) --* A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names. * *(string) --* * **TemporalStatisticsConfig** *(dict) --* An object containing information about the job configuration for temporal statistics. * **GroupBy** *(string) --* The input for the temporal statistics grouping by time frequency option. * **Statistics** *(list) --* The list of the statistics method options. * *(string) --* * **TargetBands** *(list) --* The list of target band names for the temporal statistic to calculate. * *(string) --* * **ZonalStatisticsConfig** *(dict) --* An object containing information about the job configuration for zonal statistics. * **Statistics** *(list) --* List of zonal statistics to compute. * *(string) --* * **TargetBands** *(list) --* Bands used in the operation. If no target bands are specified, it uses all bands available input. * *(string) --* * **ZoneS3Path** *(string) --* The Amazon S3 path pointing to the GeoJSON containing the polygonal zones. * **ZoneS3PathKmsKeyId** *(string) --* The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have "kms:GenerateDataKey" permission. The "KmsKeyId" can be any of the following formats: * // KMS Key ID ""1234abcd-12ab-34cd-56ef-1234567890ab"" * // Amazon Resource Name (ARN) of a KMS Key ""arn:aws:kms:::key/"" For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation. * **KmsKeyId** *(string) --* The Key Management Service 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** * "SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaE xceededException" * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / start_vector_enrichment_job start_vector_enrichment_job *************************** SageMakergeospatialcapabilities.Client.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]** The input structure for the data source that represents the storage type of the input data objects. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "S3Data". * **S3Data** *(dict) --* The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects. * **KmsKeyId** *(string) --* The Key Management Service key ID for server-side encryption. * **S3Uri** *(string) --* **[REQUIRED]** The URL to the Amazon S3 data for the Vector Enrichment job. * **DocumentType** *(string) --* **[REQUIRED]** The input structure that defines the data source file type. * **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) --* The input structure for Map Matching operation type. * **IdAttributeName** *(string) --* **[REQUIRED]** The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace. * **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) --* The input structure for Reverse Geocoding operation type. * **XAttributeName** *(string) --* **[REQUIRED]** The field name for the data that describes x-axis coordinate, eg. longitude of a point. * **YAttributeName** *(string) --* **[REQUIRED]** The field name for the data that describes y-axis coordinate, eg. latitude of a point. * **KmsKeyId** (*string*) -- The Key Management Service 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) --* The input structure for the data source that represents the storage type of the input data objects. 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) --* The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects. * **KmsKeyId** *(string) --* The Key Management Service key ID for server-side encryption. * **S3Uri** *(string) --* The URL to the Amazon S3 data for the Vector Enrichment job. * **DocumentType** *(string) --* The input structure that defines the data source file type. * **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) --* The input structure for Map Matching operation type. * **IdAttributeName** *(string) --* The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace. * **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) --* The input structure for Reverse Geocoding operation type. * **XAttributeName** *(string) --* The field name for the data that describes x-axis coordinate, eg. longitude of a point. * **YAttributeName** *(string) --* The field name for the data that describes y-axis coordinate, eg. latitude of a point. * **KmsKeyId** *(string) --* The Key Management Service 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** * "SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaE xceededException" * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / list_earth_observation_jobs list_earth_observation_jobs *************************** SageMakergeospatialcapabilities.Client.list_earth_observation_jobs(**kwargs) Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_earth_observation_jobs( MaxResults=123, NextToken='string', SortBy='string', SortOrder='ASCENDING'|'DESCENDING', StatusEquals='INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED' ) Parameters: * **MaxResults** (*integer*) -- The total number of items to return. * **NextToken** (*string*) -- If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. * **SortBy** (*string*) -- The parameter by which to sort the results. * **SortOrder** (*string*) -- An optional value that specifies whether you want the results sorted in "Ascending" or "Descending" order. * **StatusEquals** (*string*) -- A filter that retrieves only jobs with a specific status. Return type: dict Returns: **Response Syntax** { 'EarthObservationJobSummaries': [ { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'DurationInSeconds': 123, 'Name': 'string', 'OperationType': 'string', 'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED', 'Tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EarthObservationJobSummaries** *(list) --* Contains summary information about the Earth Observation jobs. * *(dict) --* An object containing information about the output file. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the list of the Earth Observation jobs. * **CreationTime** *(datetime) --* The creation time. * **DurationInSeconds** *(integer) --* The duration of the session, in seconds. * **Name** *(string) --* The names of the Earth Observation jobs in the list. * **OperationType** *(string) --* The operation type for an Earth Observation job. * **Status** *(string) --* The status of the list of the Earth Observation jobs. * **Tags** *(dict) --* Each tag consists of a key and a value. * *(string) --* * *(string) --* * **NextToken** *(string) --* If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. **Exceptions** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / close close ***** SageMakergeospatialcapabilities.Client.close() Closes underlying endpoint connections. SageMakergeospatialcapabilities / Client / get_vector_enrichment_job get_vector_enrichment_job ************************* SageMakergeospatialcapabilities.Client.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) --* The output error details for an Export operation on a Vector Enrichment job. * **ExportStatus** *(string) --* The export status of the Vector Enrichment job being initiated. * **InputConfig** *(dict) --* Input configuration information for the Vector Enrichment job. * **DataSourceConfig** *(dict) --* The input structure for the data source that represents the storage type of the input data objects. 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) --* The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects. * **KmsKeyId** *(string) --* The Key Management Service key ID for server-side encryption. * **S3Uri** *(string) --* The URL to the Amazon S3 data for the Vector Enrichment job. * **DocumentType** *(string) --* The input structure that defines the data source file type. * **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) --* The input structure for Map Matching operation type. * **IdAttributeName** *(string) --* The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace. * **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) --* The input structure for Reverse Geocoding operation type. * **XAttributeName** *(string) --* The field name for the data that describes x-axis coordinate, eg. longitude of a point. * **YAttributeName** *(string) --* The field name for the data that describes y-axis coordinate, eg. latitude of a point. * **KmsKeyId** *(string) --* The Key Management Service 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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / list_vector_enrichment_jobs list_vector_enrichment_jobs *************************** SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / tag_resource tag_resource ************ SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" SageMakergeospatialcapabilities / Client / stop_earth_observation_job stop_earth_observation_job ************************** SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / delete_earth_observation_job delete_earth_observation_job **************************** SageMakergeospatialcapabilities.Client.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** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / export_earth_observation_job export_earth_observation_job **************************** SageMakergeospatialcapabilities.Client.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 Amazon S3 location. See also: AWS API Documentation **Request Syntax** response = client.export_earth_observation_job( Arn='string', ClientToken='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. * **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. * **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 Key Management Service 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 Key Management Service key ID for server-side encryption. * **S3Uri** *(string) --* The URL to the Amazon S3 data input. **Exceptions** * "SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaE xceededException" * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException" * "SageMakergeospatialcapabilities.Client.exceptions.ConflictExcep tion" SageMakergeospatialcapabilities / Client / search_raster_data_collection search_raster_data_collection ***************************** SageMakergeospatialcapabilities.Client.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]** RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection. * **AreaOfInterest** *(dict) --* The Area of interest to be used in the search query. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "AreaOfInterestGeometry". * **AreaOfInterestGeometry** *(dict) --* A GeoJSON object representing the geographic extent in the coordinate space. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "MultiPolygonGeometry", "PolygonGeometry". * **MultiPolygonGeometry** *(dict) --* The structure representing the MultiPolygon Geometry. * **Coordinates** *(list) --* **[REQUIRED]** The coordinates of the multipolygon geometry. * *(list) --* * *(list) --* * *(list) --* * *(float) --* * **PolygonGeometry** *(dict) --* The structure representing Polygon Geometry. * **Coordinates** *(list) --* **[REQUIRED]** Coordinates representing a Polygon based on the GeoJson spec. * *(list) --* * *(list) --* * *(float) --* * **BandFilter** *(list) --* The list of Bands to be displayed in the result for each item. * *(string) --* * **PropertyFilters** *(dict) --* The Property Filters used in the search query. * **LogicalOperator** *(string) --* The Logical Operator used to combine the Property Filters. * **Properties** *(list) --* A list of Property Filters. * *(dict) --* The structure representing a single PropertyFilter. * **Property** *(dict) --* **[REQUIRED]** Represents a single property to match with when searching a raster data collection. 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) --* The structure representing EoCloudCover property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** Lower bound for EoCloudCover. * **UpperBound** *(float) --* **[REQUIRED]** Upper bound for EoCloudCover. * **LandsatCloudCoverLand** *(dict) --* The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value. * **UpperBound** *(float) --* **[REQUIRED]** The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value. * **Platform** *(dict) --* The structure representing Platform property filter consisting of value and comparison operator. * **ComparisonOperator** *(string) --* The ComparisonOperator to use with PlatformInput. * **Value** *(string) --* **[REQUIRED]** The value of the platform. * **ViewOffNadir** *(dict) --* The structure representing ViewOffNadir property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value. * **UpperBound** *(float) --* **[REQUIRED]** The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value. * **ViewSunAzimuth** *(dict) --* The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound. * **LowerBound** *(float) --* **[REQUIRED]** The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value. * **UpperBound** *(float) --* **[REQUIRED]** The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value. * **ViewSunElevation** *(dict) --* The structure representing ViewSunElevation property filter containing a lower bound and upper bound. * **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]** The TimeRange Filter used in the search query. * **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) --* Approximate number of results in the response. * **Items** *(list) --* List of items matching the Raster DataCollectionQuery. * *(dict) --* The structure representing the items in the response for SearchRasterDataCollection. * **Assets** *(dict) --* This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key. * *(string) --* * *(dict) --* The structure containing the asset properties. * **Href** *(string) --* Link to the asset object. * **DateTime** *(datetime) --* The searchable date and time of the item, in UTC. * **Geometry** *(dict) --* The item Geometry in GeoJson format. * **Coordinates** *(list) --* The coordinates of the GeoJson Geometry. * *(list) --* * *(list) --* * *(float) --* * **Type** *(string) --* GeoJson Geometry types like Polygon and MultiPolygon. * **Id** *(string) --* A unique Id for the source item. * **Properties** *(dict) --* This field contains additional properties of the item. * **EoCloudCover** *(float) --* Estimate of cloud cover. * **LandsatCloudCoverLand** *(float) --* Land cloud cover for Landsat Data Collection. * **Platform** *(string) --* Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a. * **ViewOffNadir** *(float) --* The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90). * **ViewSunAzimuth** *(float) --* The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360). * **ViewSunElevation** *(float) --* The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight. * **NextToken** *(string) --* If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. **Exceptions** * "SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedE xception" * "SageMakergeospatialcapabilities.Client.exceptions.ValidationExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.ThrottlingExc eption" * "SageMakergeospatialcapabilities.Client.exceptions.InternalServe rException" * "SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFo undException"