Class: Aws::SageMakerGeospatial::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SageMakerGeospatial::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb
Overview
An API client for SageMakerGeospatial. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SageMakerGeospatial::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#delete_earth_observation_job(params = {}) ⇒ Struct
Use this operation to delete an Earth Observation job.
-
#delete_vector_enrichment_job(params = {}) ⇒ Struct
Use this operation to delete a Vector Enrichment job.
-
#export_earth_observation_job(params = {}) ⇒ Types::ExportEarthObservationJobOutput
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.
-
#export_vector_enrichment_job(params = {}) ⇒ Types::ExportVectorEnrichmentJobOutput
Use this operation to copy results of a Vector Enrichment job to an S3 location.
-
#get_earth_observation_job(params = {}) ⇒ Types::GetEarthObservationJobOutput
Get the details for a previously initiated Earth Observation job.
-
#get_raster_data_collection(params = {}) ⇒ Types::GetRasterDataCollectionOutput
Use this operation to get details of a specific raster data collection.
-
#get_tile(params = {}) ⇒ Types::GetTileOutput
Gets a web mercator tile for the given Earth Observation job.
-
#get_vector_enrichment_job(params = {}) ⇒ Types::GetVectorEnrichmentJobOutput
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
-
#list_earth_observation_jobs(params = {}) ⇒ Types::ListEarthObservationJobOutput
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
-
#list_raster_data_collections(params = {}) ⇒ Types::ListRasterDataCollectionsOutput
Use this operation to get raster data collections.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags attached to the resource.
-
#list_vector_enrichment_jobs(params = {}) ⇒ Types::ListVectorEnrichmentJobOutput
Retrieves a list of vector enrichment jobs.
-
#search_raster_data_collection(params = {}) ⇒ Types::SearchRasterDataCollectionOutput
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
-
#start_earth_observation_job(params = {}) ⇒ Types::StartEarthObservationJobOutput
Use this operation to create an Earth observation job.
-
#start_vector_enrichment_job(params = {}) ⇒ Types::StartVectorEnrichmentJobOutput
Creates a Vector Enrichment job for the supplied job type.
-
#stop_earth_observation_job(params = {}) ⇒ Struct
Use this operation to stop an existing earth observation job.
-
#stop_vector_enrichment_job(params = {}) ⇒ Struct
Stops the Vector Enrichment job for a given job ARN.
-
#tag_resource(params = {}) ⇒ Struct
The resource you want to tag.
-
#untag_resource(params = {}) ⇒ Struct
The resource you want to untag.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#delete_earth_observation_job(params = {}) ⇒ Struct
Use this operation to delete an Earth Observation job.
389 390 391 392 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 389 def delete_earth_observation_job(params = {}, = {}) req = build_request(:delete_earth_observation_job, params) req.send_request() end |
#delete_vector_enrichment_job(params = {}) ⇒ Struct
Use this operation to delete a Vector Enrichment job.
412 413 414 415 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 412 def delete_vector_enrichment_job(params = {}, = {}) req = build_request(:delete_vector_enrichment_job, params) req.send_request() end |
#export_earth_observation_job(params = {}) ⇒ Types::ExportEarthObservationJobOutput
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.
472 473 474 475 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 472 def export_earth_observation_job(params = {}, = {}) req = build_request(:export_earth_observation_job, params) req.send_request() end |
#export_vector_enrichment_job(params = {}) ⇒ Types::ExportVectorEnrichmentJobOutput
Use this operation to copy results of a Vector Enrichment job to an S3 location.
525 526 527 528 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 525 def export_vector_enrichment_job(params = {}, = {}) req = build_request(:export_vector_enrichment_job, params) req.send_request() end |
#get_earth_observation_job(params = {}) ⇒ Types::GetEarthObservationJobOutput
Get the details for a previously initiated Earth Observation job.
648 649 650 651 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 648 def get_earth_observation_job(params = {}, = {}) req = build_request(:get_earth_observation_job, params) req.send_request() end |
#get_raster_data_collection(params = {}) ⇒ Types::GetRasterDataCollectionOutput
Use this operation to get details of a specific raster data collection.
697 698 699 700 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 697 def get_raster_data_collection(params = {}, = {}) req = build_request(:get_raster_data_collection, params) req.send_request() end |
#get_tile(params = {}) ⇒ Types::GetTileOutput
Gets a web mercator tile for the given Earth Observation job.
767 768 769 770 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 767 def get_tile(params = {}, = {}, &block) req = build_request(:get_tile, params) req.send_request(, &block) end |
#get_vector_enrichment_job(params = {}) ⇒ Types::GetVectorEnrichmentJobOutput
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
832 833 834 835 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 832 def get_vector_enrichment_job(params = {}, = {}) req = build_request(:get_vector_enrichment_job, params) req.send_request() end |
#list_earth_observation_jobs(params = {}) ⇒ Types::ListEarthObservationJobOutput
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
891 892 893 894 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 891 def list_earth_observation_jobs(params = {}, = {}) req = build_request(:list_earth_observation_jobs, params) req.send_request() end |
#list_raster_data_collections(params = {}) ⇒ Types::ListRasterDataCollectionsOutput
Use this operation to get raster data collections.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
940 941 942 943 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 940 def list_raster_data_collections(params = {}, = {}) req = build_request(:list_raster_data_collections, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags attached to the resource.
969 970 971 972 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 969 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_vector_enrichment_jobs(params = {}) ⇒ Types::ListVectorEnrichmentJobOutput
Retrieves a list of vector enrichment jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1027 def list_vector_enrichment_jobs(params = {}, = {}) req = build_request(:list_vector_enrichment_jobs, params) req.send_request() end |
#search_raster_data_collection(params = {}) ⇒ Types::SearchRasterDataCollectionOutput
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1144 def search_raster_data_collection(params = {}, = {}) req = build_request(:search_raster_data_collection, params) req.send_request() end |
#start_earth_observation_job(params = {}) ⇒ Types::StartEarthObservationJobOutput
Use this operation to create an Earth observation job.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1410 def start_earth_observation_job(params = {}, = {}) req = build_request(:start_earth_observation_job, params) req.send_request() end |
#start_vector_enrichment_job(params = {}) ⇒ Types::StartVectorEnrichmentJobOutput
Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
1518 1519 1520 1521 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1518 def start_vector_enrichment_job(params = {}, = {}) req = build_request(:start_vector_enrichment_job, params) req.send_request() end |
#stop_earth_observation_job(params = {}) ⇒ Struct
Use this operation to stop an existing earth observation job.
1541 1542 1543 1544 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1541 def stop_earth_observation_job(params = {}, = {}) req = build_request(:stop_earth_observation_job, params) req.send_request() end |
#stop_vector_enrichment_job(params = {}) ⇒ Struct
Stops the Vector Enrichment job for a given job ARN.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1563 def stop_vector_enrichment_job(params = {}, = {}) req = build_request(:stop_vector_enrichment_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
The resource you want to tag.
1591 1592 1593 1594 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1591 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
The resource you want to untag.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1617 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |