Table of Contents
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()can_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
delete_earth_observation_job(**kwargs)¶Use this operation to delete an Earth Observation job.
See also: AWS API Documentation
Request Syntax
response = client.delete_earth_observation_job(
Arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Earth Observation job being deleted.
{}
Response Structure
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptiondelete_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.
{}
Response Structure
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptionexport_earth_observation_job(**kwargs)¶Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an S3 location.
See also: AWS API Documentation
Request Syntax
response = client.export_earth_observation_job(
Arn='string',
ExecutionRoleArn='string',
ExportSourceImages=True|False,
OutputConfig={
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
)
[REQUIRED]
The input Amazon Resource Name (ARN) of the Earth Observation job being exported.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
[REQUIRED]
An object containing information about the output file.
Path to Amazon S3 storage location for the output configuration file.
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The URL to the Amazon S3 data input.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExecutionRoleArn': 'string',
'ExportSourceImages': True|False,
'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'OutputConfig': {
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
}
Response Structure
(dict) --
Arn (string) --
The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
CreationTime (datetime) --
The creation time.
ExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
ExportSourceImages (boolean) --
The source images provided to the Earth Observation job being exported.
ExportStatus (string) --
The status of the results of the Earth Observation job being exported.
OutputConfig (dict) --
An object containing information about the output file.
S3Data (dict) --
Path to Amazon S3 storage location for the output configuration file.
KmsKeyId (string) --
The Amazon Key Management Service (KMS) key ID for server-side encryption.
S3Uri (string) --
The URL to the Amazon S3 data input.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededExceptionSageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptionexport_vector_enrichment_job(**kwargs)¶Use this operation to copy results of a Vector Enrichment job to an S3 location.
See also: AWS API Documentation
Request Syntax
response = client.export_vector_enrichment_job(
Arn='string',
ExecutionRoleArn='string',
OutputConfig={
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Vector Enrichment job.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.
[REQUIRED]
Output location information for exporting Vector Enrichment Job results.
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The URL to the Amazon S3 data for the Vector Enrichment job.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExecutionRoleArn': 'string',
'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'OutputConfig': {
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
CreationTime (datetime) --
The creation time.
ExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.
ExportStatus (string) --
The status of the results the Vector Enrichment job being exported.
OutputConfig (dict) --
Output location information for exporting Vector Enrichment Job results.
S3Data (dict) --
KmsKeyId (string) --
The Amazon Key Management Service (KMS) key ID for server-side encryption.
S3Uri (string) --
The URL to the Amazon S3 data for the Vector Enrichment job.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededExceptionSageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptionget_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Earth Observation job.
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DurationInSeconds': 123,
'ErrorDetails': {
'Message': 'string',
'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
},
'ExecutionRoleArn': 'string',
'ExportErrorDetails': {
'ExportResults': {
'Message': 'string',
'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
},
'ExportSourceImages': {
'Message': 'string',
'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
}
},
'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'InputConfig': {
'DataSourceConfig': {
'S3Data': {
'KmsKeyId': 'string',
'MetadataProvider': 'PLANET_ORDER',
'S3Uri': 'string'
}
},
'PreviousEarthObservationJobArn': 'string',
'RasterDataCollectionQuery': {
'AreaOfInterest': {
'AreaOfInterestGeometry': {
'MultiPolygonGeometry': {
'Coordinates': [
[
[
[
123.0,
],
],
],
]
},
'PolygonGeometry': {
'Coordinates': [
[
[
123.0,
],
],
]
}
}
},
'PropertyFilters': {
'LogicalOperator': 'AND',
'Properties': [
{
'Property': {
'EoCloudCover': {
'LowerBound': ...,
'UpperBound': ...
},
'LandsatCloudCoverLand': {
'LowerBound': ...,
'UpperBound': ...
},
'Platform': {
'ComparisonOperator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH',
'Value': 'string'
},
'ViewOffNadir': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunAzimuth': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunElevation': {
'LowerBound': ...,
'UpperBound': ...
}
}
},
]
},
'RasterDataCollectionArn': 'string',
'RasterDataCollectionName': 'string',
'TimeRangeFilter': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
}
}
},
'JobConfig': {
'BandMathConfig': {
'CustomIndices': {
'Operations': [
{
'Equation': 'string',
'Name': 'string',
'OutputType': 'INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16'
},
]
},
'PredefinedIndices': [
'string',
]
},
'CloudMaskingConfig': {},
'CloudRemovalConfig': {
'AlgorithmName': 'INTERPOLATION',
'InterpolationValue': 'string',
'TargetBands': [
'string',
]
},
'GeoMosaicConfig': {
'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
'TargetBands': [
'string',
]
},
'LandCoverSegmentationConfig': {},
'ResamplingConfig': {
'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
'OutputResolution': {
'UserDefined': {
'Unit': 'METERS',
'Value': ...
}
},
'TargetBands': [
'string',
]
},
'StackConfig': {
'OutputResolution': {
'Predefined': 'HIGHEST'|'LOWEST'|'AVERAGE',
'UserDefined': {
'Unit': 'METERS',
'Value': ...
}
},
'TargetBands': [
'string',
]
},
'TemporalStatisticsConfig': {
'GroupBy': 'ALL'|'YEARLY',
'Statistics': [
'MEAN'|'MEDIAN'|'STANDARD_DEVIATION',
],
'TargetBands': [
'string',
]
},
'ZonalStatisticsConfig': {
'Statistics': [
'MEAN'|'MEDIAN'|'STANDARD_DEVIATION'|'MAX'|'MIN'|'SUM',
],
'TargetBands': [
'string',
],
'ZoneS3Path': 'string'
}
},
'KmsKeyId': 'string',
'Name': 'string',
'OutputBands': [
{
'BandName': 'string',
'OutputDataType': 'INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16'
},
],
'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
The Amazon Resource Name (ARN) of the Earth Observation job.
The creation time of the initiated Earth Observation job.
The duration of Earth Observation job, in seconds.
Details about the errors generated during the Earth Observation job.
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
Details about the errors generated during ExportEarthObservationJob.
The status of the Earth Observation job.
Input data for the Earth Observation job.
The location of the input data.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: S3Data. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The URL to the Amazon S3 input.
The Amazon Resource Name (ARN) of the previous Earth Observation job.
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'}
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'}
The coordinates of the multipolygon geometry.
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'}
The value of the platform.
The lower bound to view the sun elevation.
The upper bound to view the sun elevation.
The name of the raster data collection.
The end time for the time-range filter.
The start time for the time-range filter.
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'}
The name of the operation.
The type of the operation.
An object containing information about the job configuration for cloud masking.
An object containing information about the job configuration for cloud removal.
The name of the algorithm used for cloud removal.
The interpolation value you provide for cloud removal.
An object containing information about the job configuration for geomosaic.
The name of the algorithm being used for geomosaic.
The target bands for geomosaic.
An object containing information about the job configuration for land cover segmentation.
An object containing information about the job configuration for resampling.
The name of the algorithm used for resampling.
An object containing information about the job configuration for temporal statistics.
An object containing information about the job configuration for zonal statistics.
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The name of the Earth Observation job.
A single EarthObservationJob output band.
The name of the band.
The datatype of the output band.
The status of a previously initiated Earth Observation job.
Each tag consists of a key and a value.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the raster data collection.
{
'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
The Amazon Resource Name (ARN) of the raster data collection.
A description of the raster data collection.
The URL of the description page.
The name of the raster data collection.
The filters supported by the raster data collection.
The structure representing the filters supported by a RasterDataCollection.
The maximum value of the filter.
The minimum value of the filter.
The name of the filter.
The type of the filter being used.
Each tag consists of a key and a value.
The raster data collection type.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionget_tile(**kwargs)¶Gets a web mercator tile for the given Earth Observation job.
See also: AWS API Documentation
Request Syntax
response = client.get_tile(
Arn='string',
ImageAssets=[
'string',
],
ImageMask=True|False,
OutputDataType='INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16',
OutputFormat='string',
PropertyFilters='string',
Target='INPUT'|'OUTPUT',
TimeRangeFilter='string',
x=123,
y=123,
z=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the tile operation.
[REQUIRED]
The particular assets or bands to tile.
[REQUIRED]
Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
[REQUIRED]
The x coordinate of the tile input.
[REQUIRED]
The y coordinate of the tile input.
[REQUIRED]
The z coordinate of the tile input.
dict
Response Syntax
{
'BinaryFile': StreamingBody()
}
Response Structure
(dict) --
BinaryFile (StreamingBody) --
The output binary file.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionget_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Vector Enrichment job.
{
'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
The Amazon Resource Name (ARN) of the Vector Enrichment job.
The creation time.
The duration of the Vector Enrichment job, in seconds.
Details about the errors generated during the Vector Enrichment job.
A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.
The type of error generated during the Vector Enrichment job.
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
Details about the errors generated during the ExportVectorEnrichmentJob.
The message providing details about the errors generated during the Vector Enrichment job.
The export status of the Vector Enrichment job being initiated.
Input configuration information for the Vector Enrichment job.
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'}
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The URL to the Amazon S3 data for the Vector Enrichment job.
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'}
The name of the timestamp attribute.
The name of the X-attribute
The name of the Y-attribute
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The name of the Vector Enrichment job.
The status of the initiated Vector Enrichment job.
Each tag consists of a key and a value.
The type of the Vector Enrichment job being initiated.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
Ascending or Descending order.dict
Response Syntax
{
'EarthObservationJobSummaries': [
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DurationInSeconds': 123,
'Name': 'string',
'OperationType': 'string',
'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EarthObservationJobSummaries (list) --
Contains summary information about the Earth Observation jobs.
(dict) --
An object containing information about the output file.
Arn (string) --
The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.
CreationTime (datetime) --
The creation time.
DurationInSeconds (integer) --
The duration of the session, in seconds.
Name (string) --
The names of the Earth Observation jobs in the list.
OperationType (string) --
Status (string) --
The status of the list of the Earth Observation jobs.
Tags (dict) --
Each tag consists of a key and a value.
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.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionlist_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'
)
dict
Response Syntax
{
'NextToken': 'string',
'RasterDataCollectionSummaries': [
{
'Arn': 'string',
'Description': 'string',
'DescriptionPageUrl': 'string',
'Name': 'string',
'SupportedFilters': [
{
'Maximum': ...,
'Minimum': ...,
'Name': 'string',
'Type': 'string'
},
],
'Tags': {
'string': 'string'
},
'Type': 'PUBLIC'|'PREMIUM'|'USER'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
RasterDataCollectionSummaries (list) --
Contains summary information about the raster data collection.
(dict) --
Response object containing details for a specific RasterDataCollection.
Arn (string) --
The Amazon Resource Name (ARN) of the raster data collection.
Description (string) --
A description of the raster data collection.
DescriptionPageUrl (string) --
The description URL of the raster data collection.
Name (string) --
The name of the raster data collection.
SupportedFilters (list) --
(dict) --
The structure representing the filters supported by a RasterDataCollection.
Maximum (float) --
The maximum value of the filter.
Minimum (float) --
The minimum value of the filter.
Name (string) --
The name of the filter.
Type (string) --
The type of the filter being used.
Tags (dict) --
Each tag consists of a key and a value.
Type (string) --
The type of raster data collection.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionLists the tags attached to the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to tag.
{
'Tags': {
'string': 'string'
}
}
Response Structure
Each tag consists of a key and a value.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionlist_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'
)
Ascending or Descending order.dict
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.
Type (string) --
The type of the list of Vector Enrichment jobs.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionsearch_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)
}
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the raster data collection.
[REQUIRED]
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: AreaOfInterestGeometry.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.
The coordinates of the multipolygon geometry.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.
The value of the platform.
The lower bound to view the sun elevation.
The upper bound to view the sun elevation.
The end time for the time-range filter.
The start time for the time-range filter.
dict
Response Syntax
{
'ApproximateResultCount': 123,
'Items': [
{
'Assets': {
'string': {
'Href': 'string'
}
},
'DateTime': datetime(2015, 1, 1),
'Geometry': {
'Coordinates': [
[
[
123.0,
],
],
],
'Type': 'string'
},
'Id': 'string',
'Properties': {
'EoCloudCover': ...,
'LandsatCloudCoverLand': ...,
'Platform': 'string',
'ViewOffNadir': ...,
'ViewSunAzimuth': ...,
'ViewSunElevation': ...
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApproximateResultCount (integer) --
Items (list) --
(dict) --
Structure representing the items in the response for SearchRasterDataCollection.
Assets (dict) --
DateTime (datetime) --
Geometry (dict) --
Id (string) --
A unique Id for the source item.
Properties (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.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionstart_earth_observation_job(**kwargs)¶Use this operation to create an Earth observation job.
See also: AWS API Documentation
Request Syntax
response = client.start_earth_observation_job(
ClientToken='string',
ExecutionRoleArn='string',
InputConfig={
'DataSourceConfig': {
'S3Data': {
'KmsKeyId': 'string',
'MetadataProvider': 'PLANET_ORDER',
'S3Uri': 'string'
}
},
'PreviousEarthObservationJobArn': 'string',
'RasterDataCollectionQuery': {
'AreaOfInterest': {
'AreaOfInterestGeometry': {
'MultiPolygonGeometry': {
'Coordinates': [
[
[
[
123.0,
],
],
],
]
},
'PolygonGeometry': {
'Coordinates': [
[
[
123.0,
],
],
]
}
}
},
'PropertyFilters': {
'LogicalOperator': 'AND',
'Properties': [
{
'Property': {
'EoCloudCover': {
'LowerBound': ...,
'UpperBound': ...
},
'LandsatCloudCoverLand': {
'LowerBound': ...,
'UpperBound': ...
},
'Platform': {
'ComparisonOperator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH',
'Value': 'string'
},
'ViewOffNadir': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunAzimuth': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunElevation': {
'LowerBound': ...,
'UpperBound': ...
}
}
},
]
},
'RasterDataCollectionArn': 'string',
'TimeRangeFilter': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
}
}
},
JobConfig={
'BandMathConfig': {
'CustomIndices': {
'Operations': [
{
'Equation': 'string',
'Name': 'string',
'OutputType': 'INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16'
},
]
},
'PredefinedIndices': [
'string',
]
},
'CloudMaskingConfig': {}
,
'CloudRemovalConfig': {
'AlgorithmName': 'INTERPOLATION',
'InterpolationValue': 'string',
'TargetBands': [
'string',
]
},
'GeoMosaicConfig': {
'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
'TargetBands': [
'string',
]
},
'LandCoverSegmentationConfig': {}
,
'ResamplingConfig': {
'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
'OutputResolution': {
'UserDefined': {
'Unit': 'METERS',
'Value': ...
}
},
'TargetBands': [
'string',
]
},
'StackConfig': {
'OutputResolution': {
'Predefined': 'HIGHEST'|'LOWEST'|'AVERAGE',
'UserDefined': {
'Unit': 'METERS',
'Value': ...
}
},
'TargetBands': [
'string',
]
},
'TemporalStatisticsConfig': {
'GroupBy': 'ALL'|'YEARLY',
'Statistics': [
'MEAN'|'MEDIAN'|'STANDARD_DEVIATION',
],
'TargetBands': [
'string',
]
},
'ZonalStatisticsConfig': {
'Statistics': [
'MEAN'|'MEDIAN'|'STANDARD_DEVIATION'|'MAX'|'MIN'|'SUM',
],
'TargetBands': [
'string',
],
'ZoneS3Path': 'string'
}
},
KmsKeyId='string',
Name='string',
Tags={
'string': 'string'
}
)
A unique token that guarantees that the call to this API is idempotent.
This field is autopopulated if not provided.
[REQUIRED]
Input configuration information for the Earth Observation job.
The location of the input data.>
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: S3Data.
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The URL to the Amazon S3 input.
The Amazon Resource Name (ARN) of the previous Earth Observation job.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.
The coordinates of the multipolygon geometry.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.
The value of the platform.
The lower bound to view the sun elevation.
The upper bound to view the sun elevation.
The Amazon Resource Name (ARN) of the raster data collection.
The end time for the time-range filter.
The start time for the time-range filter.
[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.
The name of the operation.
The type of the operation.
An object containing information about the job configuration for cloud masking.
An object containing information about the job configuration for cloud removal.
The name of the algorithm used for cloud removal.
The interpolation value you provide for cloud removal.
An object containing information about the job configuration for geomosaic.
The name of the algorithm being used for geomosaic.
The target bands for geomosaic.
An object containing information about the job configuration for land cover segmentation.
An object containing information about the job configuration for resampling.
The name of the algorithm used for resampling.
An object containing information about the job configuration for temporal statistics.
An object containing information about the job configuration for zonal statistics.
[REQUIRED]
The name of the Earth Observation job.
Each tag consists of a key and a value.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DurationInSeconds': 123,
'ExecutionRoleArn': 'string',
'InputConfig': {
'DataSourceConfig': {
'S3Data': {
'KmsKeyId': 'string',
'MetadataProvider': 'PLANET_ORDER',
'S3Uri': 'string'
}
},
'PreviousEarthObservationJobArn': 'string',
'RasterDataCollectionQuery': {
'AreaOfInterest': {
'AreaOfInterestGeometry': {
'MultiPolygonGeometry': {
'Coordinates': [
[
[
[
123.0,
],
],
],
]
},
'PolygonGeometry': {
'Coordinates': [
[
[
123.0,
],
],
]
}
}
},
'PropertyFilters': {
'LogicalOperator': 'AND',
'Properties': [
{
'Property': {
'EoCloudCover': {
'LowerBound': ...,
'UpperBound': ...
},
'LandsatCloudCoverLand': {
'LowerBound': ...,
'UpperBound': ...
},
'Platform': {
'ComparisonOperator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH',
'Value': 'string'
},
'ViewOffNadir': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunAzimuth': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunElevation': {
'LowerBound': ...,
'UpperBound': ...
}
}
},
]
},
'RasterDataCollectionArn': 'string',
'RasterDataCollectionName': 'string',
'TimeRangeFilter': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
}
}
},
'JobConfig': {
'BandMathConfig': {
'CustomIndices': {
'Operations': [
{
'Equation': 'string',
'Name': 'string',
'OutputType': 'INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16'
},
]
},
'PredefinedIndices': [
'string',
]
},
'CloudMaskingConfig': {},
'CloudRemovalConfig': {
'AlgorithmName': 'INTERPOLATION',
'InterpolationValue': 'string',
'TargetBands': [
'string',
]
},
'GeoMosaicConfig': {
'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
'TargetBands': [
'string',
]
},
'LandCoverSegmentationConfig': {},
'ResamplingConfig': {
'AlgorithmName': 'NEAR'|'BILINEAR'|'CUBIC'|'CUBICSPLINE'|'LANCZOS'|'AVERAGE'|'RMS'|'MODE'|'MAX'|'MIN'|'MED'|'Q1'|'Q3'|'SUM',
'OutputResolution': {
'UserDefined': {
'Unit': 'METERS',
'Value': ...
}
},
'TargetBands': [
'string',
]
},
'StackConfig': {
'OutputResolution': {
'Predefined': 'HIGHEST'|'LOWEST'|'AVERAGE',
'UserDefined': {
'Unit': 'METERS',
'Value': ...
}
},
'TargetBands': [
'string',
]
},
'TemporalStatisticsConfig': {
'GroupBy': 'ALL'|'YEARLY',
'Statistics': [
'MEAN'|'MEDIAN'|'STANDARD_DEVIATION',
],
'TargetBands': [
'string',
]
},
'ZonalStatisticsConfig': {
'Statistics': [
'MEAN'|'MEDIAN'|'STANDARD_DEVIATION'|'MAX'|'MIN'|'SUM',
],
'TargetBands': [
'string',
],
'ZoneS3Path': 'string'
}
},
'KmsKeyId': 'string',
'Name': 'string',
'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Earth Observation job.
CreationTime (datetime) --
The creation time.
DurationInSeconds (integer) --
The duration of the session, in seconds.
ExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
InputConfig (dict) --
Input configuration information for the Earth Observation job.
DataSourceConfig (dict) --
The location of the input data.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: S3Data. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
S3Data (dict) --
KmsKeyId (string) --
The Amazon Key Management Service (KMS) key ID for server-side encryption.
MetadataProvider (string) --
S3Uri (string) --
The URL to the Amazon S3 input.
PreviousEarthObservationJobArn (string) --
The Amazon Resource Name (ARN) of the previous Earth Observation job.
RasterDataCollectionQuery (dict) --
AreaOfInterest (dict) --
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: AreaOfInterestGeometry. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
AreaOfInterestGeometry (dict) --
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: MultiPolygonGeometry, PolygonGeometry. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
MultiPolygonGeometry (dict) --
Coordinates (list) --
The coordinates of the multipolygon geometry.
PolygonGeometry (dict) --
PropertyFilters (dict) --
LogicalOperator (string) --
Properties (list) --
(dict) --
Property (dict) --
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
EoCloudCover (dict) --
LandsatCloudCoverLand (dict) --
Platform (dict) --
ComparisonOperator (string) --
Value (string) --
The value of the platform.
ViewOffNadir (dict) --
ViewSunAzimuth (dict) --
ViewSunElevation (dict) --
LowerBound (float) --
The lower bound to view the sun elevation.
UpperBound (float) --
The upper bound to view the sun elevation.
RasterDataCollectionArn (string) --
RasterDataCollectionName (string) --
The name of the raster data collection.
TimeRangeFilter (dict) --
EndTime (datetime) --
The end time for the time-range filter.
StartTime (datetime) --
The start time for the time-range filter.
JobConfig (dict) --
An object containing information about the job configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: BandMathConfig, CloudMaskingConfig, CloudRemovalConfig, GeoMosaicConfig, LandCoverSegmentationConfig, ResamplingConfig, StackConfig, TemporalStatisticsConfig, ZonalStatisticsConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
BandMathConfig (dict) --
CustomIndices (dict) --
Operations (list) --
(dict) --
Equation (string) --
Name (string) --
The name of the operation.
OutputType (string) --
The type of the operation.
PredefinedIndices (list) --
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) --
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.
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) --
TargetBands (list) --
StackConfig (dict) --
TemporalStatisticsConfig (dict) --
An object containing information about the job configuration for temporal statistics.
ZonalStatisticsConfig (dict) --
An object containing information about the job configuration for zonal statistics.
KmsKeyId (string) --
The Amazon Key Management Service (KMS) key ID for server-side encryption.
Name (string) --
The name of the Earth Observation job.
Status (string) --
The status of the Earth Observation job.
Tags (dict) --
Each tag consists of a key and a value.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededExceptionSageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptionstart_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'
}
)
A unique token that guarantees that the call to this API is idempotent.
This field is autopopulated if not provided.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
[REQUIRED]
Input configuration information for the Vector Enrichment job.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: S3Data.
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The URL to the Amazon S3 data for the Vector Enrichment job.
[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.
The name of the timestamp attribute.
The name of the X-attribute
The name of the Y-attribute
[REQUIRED]
The name of the Vector Enrichment job.
Each tag consists of a key and a value.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DurationInSeconds': 123,
'ExecutionRoleArn': 'string',
'InputConfig': {
'DataSourceConfig': {
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
},
'DocumentType': 'CSV'
},
'JobConfig': {
'MapMatchingConfig': {
'IdAttributeName': 'string',
'TimestampAttributeName': 'string',
'XAttributeName': 'string',
'YAttributeName': 'string'
},
'ReverseGeocodingConfig': {
'XAttributeName': 'string',
'YAttributeName': 'string'
}
},
'KmsKeyId': 'string',
'Name': 'string',
'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'STOPPED'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
},
'Type': 'REVERSE_GEOCODING'|'MAP_MATCHING'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Vector Enrichment job.
CreationTime (datetime) --
The creation time.
DurationInSeconds (integer) --
The duration of the Vector Enrichment job, in seconds.
ExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
InputConfig (dict) --
Input configuration information for starting the Vector Enrichment job.
DataSourceConfig (dict) --
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: S3Data. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
S3Data (dict) --
KmsKeyId (string) --
The Amazon Key Management Service (KMS) key ID for server-side encryption.
S3Uri (string) --
The URL to the Amazon S3 data for the Vector Enrichment job.
DocumentType (string) --
JobConfig (dict) --
An object containing information about the job configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: MapMatchingConfig, ReverseGeocodingConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
MapMatchingConfig (dict) --
IdAttributeName (string) --
TimestampAttributeName (string) --
The name of the timestamp attribute.
XAttributeName (string) --
The name of the X-attribute
YAttributeName (string) --
The name of the Y-attribute
ReverseGeocodingConfig (dict) --
KmsKeyId (string) --
The Amazon Key Management Service (KMS) key ID for server-side encryption.
Name (string) --
The name of the Vector Enrichment job.
Status (string) --
The status of the Vector Enrichment job being started.
Tags (dict) --
Each tag consists of a key and a value.
Type (string) --
The type of the Vector Enrichment job.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededExceptionSageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptionstop_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Earth Observation job being stopped.
{}
Response Structure
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptionstop_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Vector Enrichment job.
{}
Response Structure
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictExceptiontag_resource(**kwargs)¶The resource you want to tag.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to tag.
[REQUIRED]
Each tag consists of a key and a value.
dict
Response Syntax
{}
Response Structure
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶The resource you want to untag.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to untag.
[REQUIRED]
Keys of the tags you want to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionThe available paginators are:
SageMakergeospatialcapabilities.Paginator.ListEarthObservationJobsSageMakergeospatialcapabilities.Paginator.ListRasterDataCollectionsSageMakergeospatialcapabilities.Paginator.ListVectorEnrichmentJobsSageMakergeospatialcapabilities.Paginator.ListEarthObservationJobs¶paginator = client.get_paginator('list_earth_observation_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SageMakergeospatialcapabilities.Client.list_earth_observation_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SortBy='string',
SortOrder='ASCENDING'|'DESCENDING',
StatusEquals='INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Ascending or Descending order.A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EarthObservationJobSummaries': [
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DurationInSeconds': 123,
'Name': 'string',
'OperationType': 'string',
'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
(dict) --
EarthObservationJobSummaries (list) --
Contains summary information about the Earth Observation jobs.
(dict) --
An object containing information about the output file.
Arn (string) --
The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.
CreationTime (datetime) --
The creation time.
DurationInSeconds (integer) --
The duration of the session, in seconds.
Name (string) --
The names of the Earth Observation jobs in the list.
OperationType (string) --
Status (string) --
The status of the list of the Earth Observation jobs.
Tags (dict) --
Each tag consists of a key and a value.
SageMakergeospatialcapabilities.Paginator.ListRasterDataCollections¶paginator = client.get_paginator('list_raster_data_collections')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SageMakergeospatialcapabilities.Client.list_raster_data_collections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
Contains summary information about the raster data collection.
Response object containing details for a specific RasterDataCollection.
The Amazon Resource Name (ARN) of the raster data collection.
A description of the raster data collection.
The description URL of the raster data collection.
The name of the raster data collection.
The structure representing the filters supported by a RasterDataCollection.
The maximum value of the filter.
The minimum value of the filter.
The name of the filter.
The type of the filter being used.
Each tag consists of a key and a value.
The type of raster data collection.
SageMakergeospatialcapabilities.Paginator.ListVectorEnrichmentJobs¶paginator = client.get_paginator('list_vector_enrichment_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SageMakergeospatialcapabilities.Client.list_vector_enrichment_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SortBy='string',
SortOrder='ASCENDING'|'DESCENDING',
StatusEquals='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Ascending or Descending order.A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.
Type (string) --
The type of the list of Vector Enrichment jobs.