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 Amazon S3 location.
-
#export_vector_enrichment_job(params = {}) ⇒ Types::ExportVectorEnrichmentJobOutput
Use this operation to copy results of a Vector Enrichment job to an Amazon 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.
385 386 387 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#delete_earth_observation_job(params = {}) ⇒ Struct
Use this operation to delete an Earth Observation job.
409 410 411 412 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 409 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.
432 433 434 435 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 432 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 Amazon S3 location.
501 502 503 504 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 501 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 Amazon S3 location.
562 563 564 565 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 562 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.
683 684 685 686 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 683 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.
732 733 734 735 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 732 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.
806 807 808 809 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 806 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).
871 872 873 874 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 871 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.
930 931 932 933 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 930 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.
979 980 981 982 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 979 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.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1008 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.
1066 1067 1068 1069 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1066 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.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1193 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.
1450 1451 1452 1453 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1450 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1557 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.
1580 1581 1582 1583 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1580 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.
1602 1603 1604 1605 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1602 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.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1630 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
The resource you want to untag.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1656 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |