Struct aws_sdk_sagemakergeospatial::Client

pub struct Client { /* private fields */ }

Client for Amazon SageMaker geospatial capabilities

Client for invoking operations on Amazon SageMaker geospatial capabilities. Each operation on Amazon SageMaker geospatial capabilities is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_sagemakergeospatial::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_sagemakergeospatial::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_sagemakergeospatial::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn delete_earth_observation_job(&self) -> DeleteEarthObservationJob

Constructs a fluent builder for the DeleteEarthObservationJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

• On success, responds with DeleteEarthObservationJobOutput
• On failure, responds with SdkError<DeleteEarthObservationJobError>

pub fn delete_vector_enrichment_job(&self) -> DeleteVectorEnrichmentJob

Constructs a fluent builder for the DeleteVectorEnrichmentJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

• On success, responds with DeleteVectorEnrichmentJobOutput
• On failure, responds with SdkError<DeleteVectorEnrichmentJobError>

pub fn export_earth_observation_job(&self) -> ExportEarthObservationJob

Constructs a fluent builder for the ExportEarthObservationJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):

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

  • output_config(OutputConfigInput) / set_output_config(Option<OutputConfigInput>):

    An object containing information about the output file.

  • export_source_images(bool) / set_export_source_images(Option<bool>):

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

• On success, responds with ExportEarthObservationJobOutput with field(s):
  • arn(Option<String>):

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

  • creation_time(Option<DateTime>):

    The creation time.

  • export_status(Option<EarthObservationJobExportStatus>):

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

  • execution_role_arn(Option<String>):

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

  • output_config(Option<OutputConfigInput>):

    An object containing information about the output file.

  • export_source_images(Option<bool>):

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

• On failure, responds with SdkError<ExportEarthObservationJobError>

pub fn export_vector_enrichment_job(&self) -> ExportVectorEnrichmentJob

Constructs a fluent builder for the ExportVectorEnrichmentJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):

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

  • output_config(ExportVectorEnrichmentJobOutputConfig) / set_output_config(Option<ExportVectorEnrichmentJobOutputConfig>):

    Output location information for exporting Vector Enrichment Job results.

• On success, responds with ExportVectorEnrichmentJobOutput with field(s):
  • arn(Option<String>):

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

  • creation_time(Option<DateTime>):

    The creation time.

  • execution_role_arn(Option<String>):

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

  • export_status(Option<VectorEnrichmentJobExportStatus>):

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

  • output_config(Option<ExportVectorEnrichmentJobOutputConfig>):

    Output location information for exporting Vector Enrichment Job results.

• On failure, responds with SdkError<ExportVectorEnrichmentJobError>

pub fn get_earth_observation_job(&self) -> GetEarthObservationJob

Constructs a fluent builder for the GetEarthObservationJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

• On success, responds with GetEarthObservationJobOutput with field(s):
  • arn(Option<String>):

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

  • name(Option<String>):

    The name of the Earth Observation job.

  • creation_time(Option<DateTime>):

    The creation time of the initiated Earth Observation job.

  • duration_in_seconds(Option<i32>):

    The duration of Earth Observation job, in seconds.

  • status(Option<EarthObservationJobStatus>):

    The status of a previously initiated Earth Observation job.

  • kms_key_id(Option<String>):

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

  • input_config(Option<InputConfigOutput>):

    Input data for the Earth Observation job.

  • job_config(Option<JobConfigInput>):

    An object containing information about the job configuration.

  • output_bands(Option<Vec<OutputBand>>):

  • execution_role_arn(Option<String>):

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

  • error_details(Option<EarthObservationJobErrorDetails>):

    Details about the errors generated during the Earth Observation job.

  • export_status(Option<EarthObservationJobExportStatus>):

    The status of the Earth Observation job.

  • export_error_details(Option<ExportErrorDetails>):

    Details about the errors generated during ExportEarthObservationJob.

  • tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On failure, responds with SdkError<GetEarthObservationJobError>

pub fn get_raster_data_collection(&self) -> GetRasterDataCollection

Constructs a fluent builder for the GetRasterDataCollection operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

• On success, responds with GetRasterDataCollectionOutput with field(s):
  • name(Option<String>):

    The name of the raster data collection.

  • arn(Option<String>):

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

  • r#type(Option<DataCollectionType>):

    The raster data collection type.

  • description(Option<String>):

    A description of the raster data collection.

  • description_page_url(Option<String>):

    The URL of the description page.

  • supported_filters(Option<Vec<Filter>>):

    The filters supported by the raster data collection.

  • image_source_bands(Option<Vec<String>>):

  • tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On failure, responds with SdkError<GetRasterDataCollectionError>

pub fn get_tile(&self) -> GetTile

Constructs a fluent builder for the GetTile operation.

• The fluent builder is configurable:
  • x(i32) / set_x(Option<i32>):

    The x coordinate of the tile input.

  • y(i32) / set_y(Option<i32>):

    The y coordinate of the tile input.

  • z(i32) / set_z(Option<i32>):

    The z coordinate of the tile input.

  • image_assets(Vec<String>) / set_image_assets(Option<Vec<String>>):

    The particular assets or bands to tile.

  • target(TargetOptions) / set_target(Option<TargetOptions>):

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

  • arn(impl Into<String>) / set_arn(Option<String>):

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

  • image_mask(bool) / set_image_mask(Option<bool>):

    Determines whether or not to return a valid data mask.

  • output_format(impl Into<String>) / set_output_format(Option<String>):

    The data format of the output tile. The formats include .npy, .png and .jpg.

  • time_range_filter(impl Into<String>) / set_time_range_filter(Option<String>):

    Time range filter applied to imagery to find the images to tile.

  • property_filters(impl Into<String>) / set_property_filters(Option<String>):

    Property filters for the imagery to tile.

  • output_data_type(OutputType) / set_output_data_type(Option<OutputType>):

    The output data type of the tile operation.

• On success, responds with GetTileOutput with field(s):
  • binary_file(ByteStream):

    The output binary file.

• On failure, responds with SdkError<GetTileError>

pub fn get_vector_enrichment_job(&self) -> GetVectorEnrichmentJob

Constructs a fluent builder for the GetVectorEnrichmentJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

• On success, responds with GetVectorEnrichmentJobOutput with field(s):
  • arn(Option<String>):

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

  • r#type(Option<VectorEnrichmentJobType>):

    The type of the Vector Enrichment job being initiated.

  • name(Option<String>):

    The name of the Vector Enrichment job.

  • creation_time(Option<DateTime>):

    The creation time.

  • duration_in_seconds(Option<i32>):

    The duration of the Vector Enrichment job, in seconds.

  • status(Option<VectorEnrichmentJobStatus>):

    The status of the initiated Vector Enrichment job.

  • kms_key_id(Option<String>):

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

  • input_config(Option<VectorEnrichmentJobInputConfig>):

    Input configuration information for the Vector Enrichment job.

  • job_config(Option<VectorEnrichmentJobConfig>):

    An object containing information about the job configuration.

  • execution_role_arn(Option<String>):

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

  • error_details(Option<VectorEnrichmentJobErrorDetails>):

    Details about the errors generated during the Vector Enrichment job.

  • export_status(Option<VectorEnrichmentJobExportStatus>):

    The export status of the Vector Enrichment job being initiated.

  • export_error_details(Option<VectorEnrichmentJobExportErrorDetails>):

    Details about the errors generated during the ExportVectorEnrichmentJob.

  • tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On failure, responds with SdkError<GetVectorEnrichmentJobError>

pub fn list_earth_observation_jobs(&self) -> ListEarthObservationJobs

Constructs a fluent builder for the ListEarthObservationJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • status_equals(EarthObservationJobStatus) / set_status_equals(Option<EarthObservationJobStatus>):

    A filter that retrieves only jobs with a specific status.

  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

  • sort_by(impl Into<String>) / set_sort_by(Option<String>):

    The parameter by which to sort the results.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The total number of items to return.

• On success, responds with ListEarthObservationJobsOutput with field(s):
  • earth_observation_job_summaries(Option<Vec<ListEarthObservationJobOutputConfig>>):

    Contains summary information about the Earth Observation jobs.

  • next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

• On failure, responds with SdkError<ListEarthObservationJobsError>

pub fn list_raster_data_collections(&self) -> ListRasterDataCollections

Constructs a fluent builder for the ListRasterDataCollections operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The total number of items to return.

• On success, responds with ListRasterDataCollectionsOutput with field(s):
  • raster_data_collection_summaries(Option<Vec<RasterDataCollectionMetadata>>):

    Contains summary information about the raster data collection.

  • next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

• On failure, responds with SdkError<ListRasterDataCollectionsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

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

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn list_vector_enrichment_jobs(&self) -> ListVectorEnrichmentJobs

Constructs a fluent builder for the ListVectorEnrichmentJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • status_equals(impl Into<String>) / set_status_equals(Option<String>):

    A filter that retrieves only jobs with a specific status.

  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

  • sort_by(impl Into<String>) / set_sort_by(Option<String>):

    The parameter by which to sort the results.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of items to return.

• On success, responds with ListVectorEnrichmentJobsOutput with field(s):
  • vector_enrichment_job_summaries(Option<Vec<ListVectorEnrichmentJobOutputConfig>>):

    Contains summary information about the Vector Enrichment jobs.

  • next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

• On failure, responds with SdkError<ListVectorEnrichmentJobsError>

pub fn search_raster_data_collection(&self) -> SearchRasterDataCollection

Constructs a fluent builder for the SearchRasterDataCollection operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

  • raster_data_collection_query(RasterDataCollectionQueryWithBandFilterInput) / set_raster_data_collection_query(Option<RasterDataCollectionQueryWithBandFilterInput>):

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

• On success, responds with SearchRasterDataCollectionOutput with field(s):
  • approximate_result_count(Option<i32>):

  • next_token(Option<String>):

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • items(Option<Vec<ItemSource>>):

• On failure, responds with SdkError<SearchRasterDataCollectionError>

pub fn start_earth_observation_job(&self) -> StartEarthObservationJob

Constructs a fluent builder for the StartEarthObservationJob operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the Earth Observation job.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

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

  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):

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

  • input_config(InputConfigInput) / set_input_config(Option<InputConfigInput>):

    Input configuration information for the Earth Observation job.

  • job_config(JobConfigInput) / set_job_config(Option<JobConfigInput>):

    An object containing information about the job configuration.

  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):

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

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On success, responds with StartEarthObservationJobOutput with field(s):
  • name(Option<String>):

    The name of the Earth Observation job.

  • arn(Option<String>):

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

  • creation_time(Option<DateTime>):

    The creation time.

  • duration_in_seconds(Option<i32>):

    The duration of the session, in seconds.

  • status(Option<EarthObservationJobStatus>):

    The status of the Earth Observation job.

  • kms_key_id(Option<String>):

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

  • input_config(Option<InputConfigOutput>):

    Input configuration information for the Earth Observation job.

  • job_config(Option<JobConfigInput>):

    An object containing information about the job configuration.

  • execution_role_arn(Option<String>):

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

  • tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On failure, responds with SdkError<StartEarthObservationJobError>

pub fn start_vector_enrichment_job(&self) -> StartVectorEnrichmentJob

Constructs a fluent builder for the StartVectorEnrichmentJob operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the Vector Enrichment job.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

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

  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):

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

  • input_config(VectorEnrichmentJobInputConfig) / set_input_config(Option<VectorEnrichmentJobInputConfig>):

    Input configuration information for the Vector Enrichment job.

  • job_config(VectorEnrichmentJobConfig) / set_job_config(Option<VectorEnrichmentJobConfig>):

    An object containing information about the job configuration.

  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):

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

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On success, responds with StartVectorEnrichmentJobOutput with field(s):
  • name(Option<String>):

    The name of the Vector Enrichment job.

  • arn(Option<String>):

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

  • r#type(Option<VectorEnrichmentJobType>):

    The type of the Vector Enrichment job.

  • creation_time(Option<DateTime>):

    The creation time.

  • duration_in_seconds(Option<i32>):

    The duration of the Vector Enrichment job, in seconds.

  • status(Option<VectorEnrichmentJobStatus>):

    The status of the Vector Enrichment job being started.

  • kms_key_id(Option<String>):

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

  • input_config(Option<VectorEnrichmentJobInputConfig>):

    Input configuration information for starting the Vector Enrichment job.

  • job_config(Option<VectorEnrichmentJobConfig>):

    An object containing information about the job configuration.

  • execution_role_arn(Option<String>):

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

  • tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On failure, responds with SdkError<StartVectorEnrichmentJobError>

pub fn stop_earth_observation_job(&self) -> StopEarthObservationJob

Constructs a fluent builder for the StopEarthObservationJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

• On success, responds with StopEarthObservationJobOutput
• On failure, responds with SdkError<StopEarthObservationJobError>

pub fn stop_vector_enrichment_job(&self) -> StopVectorEnrichmentJob

Constructs a fluent builder for the StopVectorEnrichmentJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

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

• On success, responds with StopVectorEnrichmentJobOutput
• On failure, responds with SdkError<StopVectorEnrichmentJobError>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

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

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Each tag consists of a key and a value.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

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

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    Keys of the tags you want to remove.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.