Class: Aws::SageMakerGeospatial::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::SageMakerGeospatial::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::SageMakerGeospatial::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



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.

Examples:

Request syntax with placeholder values


resp = client.delete_earth_observation_job({
  arn: "EarthObservationJobArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



389
390
391
392
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 389

def delete_earth_observation_job(params = {}, options = {})
  req = build_request(:delete_earth_observation_job, params)
  req.send_request(options)
end

#delete_vector_enrichment_job(params = {}) ⇒ Struct

Use this operation to delete a Vector Enrichment job.

Examples:

Request syntax with placeholder values


resp = client.delete_vector_enrichment_job({
  arn: "VectorEnrichmentJobArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



412
413
414
415
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 412

def delete_vector_enrichment_job(params = {}, options = {})
  req = build_request(:delete_vector_enrichment_job, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.export_earth_observation_job({
  arn: "EarthObservationJobArn", # required
  execution_role_arn: "String", # required
  export_source_images: false,
  output_config: { # required
    s3_data: { # required
      kms_key_id: "String",
      s3_uri: "String", # required
    },
  },
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.execution_role_arn #=> String
resp.export_source_images #=> Boolean
resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.output_config.s3_data.kms_key_id #=> String
resp.output_config.s3_data.s3_uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :execution_role_arn (required, String) —

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

  • :export_source_images (Boolean) —

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

  • :output_config (required, Types::OutputConfigInput) —

    An object containing information about the output file.

Returns:

See Also:



472
473
474
475
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 472

def export_earth_observation_job(params = {}, options = {})
  req = build_request(:export_earth_observation_job, params)
  req.send_request(options)
end

#export_vector_enrichment_job(params = {}) ⇒ Types::ExportVectorEnrichmentJobOutput

Use this operation to copy results of a Vector Enrichment job to an S3 location.

Examples:

Request syntax with placeholder values


resp = client.export_vector_enrichment_job({
  arn: "VectorEnrichmentJobArn", # required
  execution_role_arn: "String", # required
  output_config: { # required
    s3_data: { # required
      kms_key_id: "String",
      s3_uri: "String", # required
    },
  },
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.execution_role_arn #=> String
resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.output_config.s3_data.kms_key_id #=> String
resp.output_config.s3_data.s3_uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :execution_role_arn (required, String) —

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

  • :output_config (required, Types::ExportVectorEnrichmentJobOutputConfig) —

    Output location information for exporting Vector Enrichment Job results.

Returns:

See Also:



525
526
527
528
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 525

def export_vector_enrichment_job(params = {}, options = {})
  req = build_request(:export_vector_enrichment_job, params)
  req.send_request(options)
end

#get_earth_observation_job(params = {}) ⇒ Types::GetEarthObservationJobOutput

Get the details for a previously initiated Earth Observation job.

Examples:

Request syntax with placeholder values


resp = client.get_earth_observation_job({
  arn: "EarthObservationJobArn", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.duration_in_seconds #=> Integer
resp.error_details.message #=> String
resp.error_details.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
resp.execution_role_arn #=> String
resp.export_error_details.export_results.message #=> String
resp.export_error_details.export_results.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
resp.export_error_details.export_source_images.message #=> String
resp.export_error_details.export_source_images.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.input_config.data_source_config.s3_data.kms_key_id #=> String
resp.input_config.data_source_config.s3_data.metadata_provider #=> String, one of "PLANET_ORDER"
resp.input_config.data_source_config.s3_data.s3_uri #=> String
resp.input_config.previous_earth_observation_job_arn #=> String
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0][0] #=> Float
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0][0] #=> Float
resp.input_config.raster_data_collection_query.property_filters.logical_operator #=> String, one of "AND"
resp.input_config.raster_data_collection_query.property_filters.properties #=> Array
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.comparison_operator #=> String, one of "EQUALS", "NOT_EQUALS", "STARTS_WITH"
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.value #=> String
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.upper_bound #=> Float
resp.input_config.raster_data_collection_query.raster_data_collection_arn #=> String
resp.input_config.raster_data_collection_query.raster_data_collection_name #=> String
resp.input_config.raster_data_collection_query.time_range_filter.end_time #=> Time
resp.input_config.raster_data_collection_query.time_range_filter.start_time #=> Time
resp.job_config.band_math_config.custom_indices.operations #=> Array
resp.job_config.band_math_config.custom_indices.operations[0].equation #=> String
resp.job_config.band_math_config.custom_indices.operations[0].name #=> String
resp.job_config.band_math_config.custom_indices.operations[0].output_type #=> String, one of "INT32", "FLOAT32", "INT16", "FLOAT64", "UINT16"
resp.job_config.band_math_config.predefined_indices #=> Array
resp.job_config.band_math_config.predefined_indices[0] #=> String
resp.job_config.cloud_removal_config.algorithm_name #=> String, one of "INTERPOLATION"
resp.job_config.cloud_removal_config.interpolation_value #=> String
resp.job_config.cloud_removal_config.target_bands #=> Array
resp.job_config.cloud_removal_config.target_bands[0] #=> String
resp.job_config.geo_mosaic_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
resp.job_config.geo_mosaic_config.target_bands #=> Array
resp.job_config.geo_mosaic_config.target_bands[0] #=> String
resp.job_config.resampling_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
resp.job_config.resampling_config.output_resolution.user_defined.unit #=> String, one of "METERS"
resp.job_config.resampling_config.output_resolution.user_defined.value #=> Float
resp.job_config.resampling_config.target_bands #=> Array
resp.job_config.resampling_config.target_bands[0] #=> String
resp.job_config.stack_config.output_resolution.predefined #=> String, one of "HIGHEST", "LOWEST", "AVERAGE"
resp.job_config.stack_config.output_resolution.user_defined.unit #=> String, one of "METERS"
resp.job_config.stack_config.output_resolution.user_defined.value #=> Float
resp.job_config.stack_config.target_bands #=> Array
resp.job_config.stack_config.target_bands[0] #=> String
resp.job_config.temporal_statistics_config.group_by #=> String, one of "ALL", "YEARLY"
resp.job_config.temporal_statistics_config.statistics #=> Array
resp.job_config.temporal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION"
resp.job_config.temporal_statistics_config.target_bands #=> Array
resp.job_config.temporal_statistics_config.target_bands[0] #=> String
resp.job_config.zonal_statistics_config.statistics #=> Array
resp.job_config.zonal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION", "MAX", "MIN", "SUM"
resp.job_config.zonal_statistics_config.target_bands #=> Array
resp.job_config.zonal_statistics_config.target_bands[0] #=> String
resp.job_config.zonal_statistics_config.zone_s3_path #=> String
resp.kms_key_id #=> String
resp.name #=> String
resp.output_bands #=> Array
resp.output_bands[0].band_name #=> String
resp.output_bands[0].output_data_type #=> String, one of "INT32", "FLOAT32", "INT16", "FLOAT64", "UINT16"
resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "COMPLETED", "STOPPED", "FAILED", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

See Also:



648
649
650
651
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 648

def get_earth_observation_job(params = {}, options = {})
  req = build_request(:get_earth_observation_job, params)
  req.send_request(options)
end

#get_raster_data_collection(params = {}) ⇒ Types::GetRasterDataCollectionOutput

Use this operation to get details of a specific raster data collection.

Examples:

Request syntax with placeholder values


resp = client.get_raster_data_collection({
  arn: "DataCollectionArn", # required
})

Response structure


resp.arn #=> String
resp.description #=> String
resp.description_page_url #=> String
resp.image_source_bands #=> Array
resp.image_source_bands[0] #=> String
resp.name #=> String
resp.supported_filters #=> Array
resp.supported_filters[0].maximum #=> Float
resp.supported_filters[0].minimum #=> Float
resp.supported_filters[0].name #=> String
resp.supported_filters[0].type #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.type #=> String, one of "PUBLIC", "PREMIUM", "USER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

See Also:



697
698
699
700
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 697

def get_raster_data_collection(params = {}, options = {})
  req = build_request(:get_raster_data_collection, params)
  req.send_request(options)
end

#get_tile(params = {}) ⇒ Types::GetTileOutput

Gets a web mercator tile for the given Earth Observation job.

Examples:

Request syntax with placeholder values


resp = client.get_tile({
  arn: "EarthObservationJobArn", # required
  image_assets: ["String"], # required
  image_mask: false,
  output_data_type: "INT32", # accepts INT32, FLOAT32, INT16, FLOAT64, UINT16
  output_format: "String",
  property_filters: "String",
  target: "INPUT", # required, accepts INPUT, OUTPUT
  time_range_filter: "String",
  x: 1, # required
  y: 1, # required
  z: 1, # required
})

Response structure


resp.binary_file #=> IO

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :image_assets (required, Array<String>) —

    The particular assets or bands to tile.

  • :image_mask (Boolean) —

    Determines whether or not to return a valid data mask.

  • :output_data_type (String) —

    The output data type of the tile operation.

  • :output_format (String) —

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

  • :property_filters (String) —

    Property filters for the imagery to tile.

  • :target (required, String) —

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

  • :time_range_filter (String) —

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

  • :x (required, Integer) —

    The x coordinate of the tile input.

  • :y (required, Integer) —

    The y coordinate of the tile input.

  • :z (required, Integer) —

    The z coordinate of the tile input.

Returns:

See Also:



767
768
769
770
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 767

def get_tile(params = {}, options = {}, &block)
  req = build_request(:get_tile, params)
  req.send_request(options, &block)
end

#get_vector_enrichment_job(params = {}) ⇒ Types::GetVectorEnrichmentJobOutput

Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).

Examples:

Request syntax with placeholder values


resp = client.get_vector_enrichment_job({
  arn: "VectorEnrichmentJobArn", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.duration_in_seconds #=> Integer
resp.error_details.error_message #=> String
resp.error_details.error_type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
resp.execution_role_arn #=> String
resp.export_error_details.message #=> String
resp.export_error_details.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.input_config.data_source_config.s3_data.kms_key_id #=> String
resp.input_config.data_source_config.s3_data.s3_uri #=> String
resp.input_config.document_type #=> String, one of "CSV"
resp.job_config.map_matching_config.id_attribute_name #=> String
resp.job_config.map_matching_config.timestamp_attribute_name #=> String
resp.job_config.map_matching_config.x_attribute_name #=> String
resp.job_config.map_matching_config.y_attribute_name #=> String
resp.job_config.reverse_geocoding_config.x_attribute_name #=> String
resp.job_config.reverse_geocoding_config.y_attribute_name #=> String
resp.kms_key_id #=> String
resp.name #=> String
resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "STOPPED", "COMPLETED", "FAILED", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.type #=> String, one of "REVERSE_GEOCODING", "MAP_MATCHING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

See Also:



832
833
834
835
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 832

def get_vector_enrichment_job(params = {}, options = {})
  req = build_request(:get_vector_enrichment_job, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_earth_observation_jobs({
  max_results: 1,
  next_token: "NextToken",
  sort_by: "String",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  status_equals: "INITIALIZING", # accepts INITIALIZING, IN_PROGRESS, STOPPING, COMPLETED, STOPPED, FAILED, DELETING, DELETED
})

Response structure


resp.earth_observation_job_summaries #=> Array
resp.earth_observation_job_summaries[0].arn #=> String
resp.earth_observation_job_summaries[0].creation_time #=> Time
resp.earth_observation_job_summaries[0].duration_in_seconds #=> Integer
resp.earth_observation_job_summaries[0].name #=> String
resp.earth_observation_job_summaries[0].operation_type #=> String
resp.earth_observation_job_summaries[0].status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "COMPLETED", "STOPPED", "FAILED", "DELETING", "DELETED"
resp.earth_observation_job_summaries[0].tags #=> Hash
resp.earth_observation_job_summaries[0].tags["String"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The total number of items to return.

  • :next_token (String) —

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

  • :sort_by (String) —

    The parameter by which to sort the results.

  • :sort_order (String) —

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

  • :status_equals (String) —

    A filter that retrieves only jobs with a specific status.

Returns:

See Also:



891
892
893
894
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 891

def list_earth_observation_jobs(params = {}, options = {})
  req = build_request(:list_earth_observation_jobs, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_raster_data_collections({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.raster_data_collection_summaries #=> Array
resp.raster_data_collection_summaries[0].arn #=> String
resp.raster_data_collection_summaries[0].description #=> String
resp.raster_data_collection_summaries[0].description_page_url #=> String
resp.raster_data_collection_summaries[0].name #=> String
resp.raster_data_collection_summaries[0].supported_filters #=> Array
resp.raster_data_collection_summaries[0].supported_filters[0].maximum #=> Float
resp.raster_data_collection_summaries[0].supported_filters[0].minimum #=> Float
resp.raster_data_collection_summaries[0].supported_filters[0].name #=> String
resp.raster_data_collection_summaries[0].supported_filters[0].type #=> String
resp.raster_data_collection_summaries[0].tags #=> Hash
resp.raster_data_collection_summaries[0].tags["String"] #=> String
resp.raster_data_collection_summaries[0].type #=> String, one of "PUBLIC", "PREMIUM", "USER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The total number of items to return.

  • :next_token (String) —

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

Returns:

See Also:



940
941
942
943
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 940

def list_raster_data_collections(params = {}, options = {})
  req = build_request(:list_raster_data_collections, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags attached to the resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



969
970
971
972
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 969

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_vector_enrichment_jobs({
  max_results: 1,
  next_token: "NextToken",
  sort_by: "String",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  status_equals: "String",
})

Response structure


resp.next_token #=> String
resp.vector_enrichment_job_summaries #=> Array
resp.vector_enrichment_job_summaries[0].arn #=> String
resp.vector_enrichment_job_summaries[0].creation_time #=> Time
resp.vector_enrichment_job_summaries[0].duration_in_seconds #=> Integer
resp.vector_enrichment_job_summaries[0].name #=> String
resp.vector_enrichment_job_summaries[0].status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "STOPPED", "COMPLETED", "FAILED", "DELETING", "DELETED"
resp.vector_enrichment_job_summaries[0].tags #=> Hash
resp.vector_enrichment_job_summaries[0].tags["String"] #=> String
resp.vector_enrichment_job_summaries[0].type #=> String, one of "REVERSE_GEOCODING", "MAP_MATCHING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return.

  • :next_token (String) —

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

  • :sort_by (String) —

    The parameter by which to sort the results.

  • :sort_order (String) —

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

  • :status_equals (String) —

    A filter that retrieves only jobs with a specific status.

Returns:

See Also:



1027
1028
1029
1030
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1027

def list_vector_enrichment_jobs(params = {}, options = {})
  req = build_request(:list_vector_enrichment_jobs, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.search_raster_data_collection({
  arn: "DataCollectionArn", # required
  next_token: "NextToken",
  raster_data_collection_query: { # required
    area_of_interest: {
      area_of_interest_geometry: {
        multi_polygon_geometry: {
          coordinates: [ # required
            [
              [
                [1.0],
              ],
            ],
          ],
        },
        polygon_geometry: {
          coordinates: [ # required
            [
              [1.0],
            ],
          ],
        },
      },
    },
    band_filter: ["String"],
    property_filters: {
      logical_operator: "AND", # accepts AND
      properties: [
        {
          property: { # required
            eo_cloud_cover: {
              lower_bound: 1.0, # required
              upper_bound: 1.0, # required
            },
            landsat_cloud_cover_land: {
              lower_bound: 1.0, # required
              upper_bound: 1.0, # required
            },
            platform: {
              comparison_operator: "EQUALS", # accepts EQUALS, NOT_EQUALS, STARTS_WITH
              value: "String", # required
            },
            view_off_nadir: {
              lower_bound: 1.0, # required
              upper_bound: 1.0, # required
            },
            view_sun_azimuth: {
              lower_bound: 1.0, # required
              upper_bound: 1.0, # required
            },
            view_sun_elevation: {
              lower_bound: 1.0, # required
              upper_bound: 1.0, # required
            },
          },
        },
      ],
    },
    time_range_filter: { # required
      end_time: Time.now, # required
      start_time: Time.now, # required
    },
  },
})

Response structure


resp.approximate_result_count #=> Integer
resp.items #=> Array
resp.items[0].assets #=> Hash
resp.items[0].assets["String"].href #=> String
resp.items[0].date_time #=> Time
resp.items[0].geometry.coordinates #=> Array
resp.items[0].geometry.coordinates[0] #=> Array
resp.items[0].geometry.coordinates[0][0] #=> Array
resp.items[0].geometry.coordinates[0][0][0] #=> Float
resp.items[0].geometry.type #=> String
resp.items[0].id #=> String
resp.items[0].properties.eo_cloud_cover #=> Float
resp.items[0].properties.landsat_cloud_cover_land #=> Float
resp.items[0].properties.platform #=> String
resp.items[0].properties.view_off_nadir #=> Float
resp.items[0].properties.view_sun_azimuth #=> Float
resp.items[0].properties.view_sun_elevation #=> Float
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :next_token (String) —

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

  • :raster_data_collection_query (required, Types::RasterDataCollectionQueryWithBandFilterInput)

Returns:

See Also:



1144
1145
1146
1147
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1144

def search_raster_data_collection(params = {}, options = {})
  req = build_request(:search_raster_data_collection, params)
  req.send_request(options)
end

#start_earth_observation_job(params = {}) ⇒ Types::StartEarthObservationJobOutput

Use this operation to create an Earth observation job.

Examples:

Request syntax with placeholder values


resp = client.start_earth_observation_job({
  client_token: "String",
  execution_role_arn: "String",
  input_config: { # required
    data_source_config: {
      s3_data: {
        kms_key_id: "String",
        metadata_provider: "PLANET_ORDER", # required, accepts PLANET_ORDER
        s3_uri: "String", # required
      },
    },
    previous_earth_observation_job_arn: "String",
    raster_data_collection_query: {
      area_of_interest: {
        area_of_interest_geometry: {
          multi_polygon_geometry: {
            coordinates: [ # required
              [
                [
                  [1.0],
                ],
              ],
            ],
          },
          polygon_geometry: {
            coordinates: [ # required
              [
                [1.0],
              ],
            ],
          },
        },
      },
      property_filters: {
        logical_operator: "AND", # accepts AND
        properties: [
          {
            property: { # required
              eo_cloud_cover: {
                lower_bound: 1.0, # required
                upper_bound: 1.0, # required
              },
              landsat_cloud_cover_land: {
                lower_bound: 1.0, # required
                upper_bound: 1.0, # required
              },
              platform: {
                comparison_operator: "EQUALS", # accepts EQUALS, NOT_EQUALS, STARTS_WITH
                value: "String", # required
              },
              view_off_nadir: {
                lower_bound: 1.0, # required
                upper_bound: 1.0, # required
              },
              view_sun_azimuth: {
                lower_bound: 1.0, # required
                upper_bound: 1.0, # required
              },
              view_sun_elevation: {
                lower_bound: 1.0, # required
                upper_bound: 1.0, # required
              },
            },
          },
        ],
      },
      raster_data_collection_arn: "String", # required
      time_range_filter: { # required
        end_time: Time.now, # required
        start_time: Time.now, # required
      },
    },
  },
  job_config: { # required
    band_math_config: {
      custom_indices: {
        operations: [
          {
            equation: "String", # required
            name: "String", # required
            output_type: "INT32", # accepts INT32, FLOAT32, INT16, FLOAT64, UINT16
          },
        ],
      },
      predefined_indices: ["String"],
    },
    cloud_masking_config: {
    },
    cloud_removal_config: {
      algorithm_name: "INTERPOLATION", # accepts INTERPOLATION
      interpolation_value: "String",
      target_bands: ["String"],
    },
    geo_mosaic_config: {
      algorithm_name: "NEAR", # accepts NEAR, BILINEAR, CUBIC, CUBICSPLINE, LANCZOS, AVERAGE, RMS, MODE, MAX, MIN, MED, Q1, Q3, SUM
      target_bands: ["String"],
    },
    land_cover_segmentation_config: {
    },
    resampling_config: {
      algorithm_name: "NEAR", # accepts NEAR, BILINEAR, CUBIC, CUBICSPLINE, LANCZOS, AVERAGE, RMS, MODE, MAX, MIN, MED, Q1, Q3, SUM
      output_resolution: { # required
        user_defined: { # required
          unit: "METERS", # required, accepts METERS
          value: 1.0, # required
        },
      },
      target_bands: ["String"],
    },
    stack_config: {
      output_resolution: {
        predefined: "HIGHEST", # accepts HIGHEST, LOWEST, AVERAGE
        user_defined: {
          unit: "METERS", # required, accepts METERS
          value: 1.0, # required
        },
      },
      target_bands: ["String"],
    },
    temporal_statistics_config: {
      group_by: "ALL", # accepts ALL, YEARLY
      statistics: ["MEAN"], # required, accepts MEAN, MEDIAN, STANDARD_DEVIATION
      target_bands: ["String"],
    },
    zonal_statistics_config: {
      statistics: ["MEAN"], # required, accepts MEAN, MEDIAN, STANDARD_DEVIATION, MAX, MIN, SUM
      target_bands: ["String"],
      zone_s3_path: "String", # required
    },
  },
  kms_key_id: "String",
  name: "String", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.duration_in_seconds #=> Integer
resp.execution_role_arn #=> String
resp.input_config.data_source_config.s3_data.kms_key_id #=> String
resp.input_config.data_source_config.s3_data.metadata_provider #=> String, one of "PLANET_ORDER"
resp.input_config.data_source_config.s3_data.s3_uri #=> String
resp.input_config.previous_earth_observation_job_arn #=> String
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0][0] #=> Float
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0] #=> Array
resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0][0] #=> Float
resp.input_config.raster_data_collection_query.property_filters.logical_operator #=> String, one of "AND"
resp.input_config.raster_data_collection_query.property_filters.properties #=> Array
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.comparison_operator #=> String, one of "EQUALS", "NOT_EQUALS", "STARTS_WITH"
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.value #=> String
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.upper_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.lower_bound #=> Float
resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.upper_bound #=> Float
resp.input_config.raster_data_collection_query.raster_data_collection_arn #=> String
resp.input_config.raster_data_collection_query.raster_data_collection_name #=> String
resp.input_config.raster_data_collection_query.time_range_filter.end_time #=> Time
resp.input_config.raster_data_collection_query.time_range_filter.start_time #=> Time
resp.job_config.band_math_config.custom_indices.operations #=> Array
resp.job_config.band_math_config.custom_indices.operations[0].equation #=> String
resp.job_config.band_math_config.custom_indices.operations[0].name #=> String
resp.job_config.band_math_config.custom_indices.operations[0].output_type #=> String, one of "INT32", "FLOAT32", "INT16", "FLOAT64", "UINT16"
resp.job_config.band_math_config.predefined_indices #=> Array
resp.job_config.band_math_config.predefined_indices[0] #=> String
resp.job_config.cloud_removal_config.algorithm_name #=> String, one of "INTERPOLATION"
resp.job_config.cloud_removal_config.interpolation_value #=> String
resp.job_config.cloud_removal_config.target_bands #=> Array
resp.job_config.cloud_removal_config.target_bands[0] #=> String
resp.job_config.geo_mosaic_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
resp.job_config.geo_mosaic_config.target_bands #=> Array
resp.job_config.geo_mosaic_config.target_bands[0] #=> String
resp.job_config.resampling_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
resp.job_config.resampling_config.output_resolution.user_defined.unit #=> String, one of "METERS"
resp.job_config.resampling_config.output_resolution.user_defined.value #=> Float
resp.job_config.resampling_config.target_bands #=> Array
resp.job_config.resampling_config.target_bands[0] #=> String
resp.job_config.stack_config.output_resolution.predefined #=> String, one of "HIGHEST", "LOWEST", "AVERAGE"
resp.job_config.stack_config.output_resolution.user_defined.unit #=> String, one of "METERS"
resp.job_config.stack_config.output_resolution.user_defined.value #=> Float
resp.job_config.stack_config.target_bands #=> Array
resp.job_config.stack_config.target_bands[0] #=> String
resp.job_config.temporal_statistics_config.group_by #=> String, one of "ALL", "YEARLY"
resp.job_config.temporal_statistics_config.statistics #=> Array
resp.job_config.temporal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION"
resp.job_config.temporal_statistics_config.target_bands #=> Array
resp.job_config.temporal_statistics_config.target_bands[0] #=> String
resp.job_config.zonal_statistics_config.statistics #=> Array
resp.job_config.zonal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION", "MAX", "MIN", "SUM"
resp.job_config.zonal_statistics_config.target_bands #=> Array
resp.job_config.zonal_statistics_config.target_bands[0] #=> String
resp.job_config.zonal_statistics_config.zone_s3_path #=> String
resp.kms_key_id #=> String
resp.name #=> String
resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "COMPLETED", "STOPPED", "FAILED", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :execution_role_arn (String) —

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

  • :input_config (required, Types::InputConfigInput) —

    Input configuration information for the Earth Observation job.

  • :job_config (required, Types::JobConfigInput) —

    An object containing information about the job configuration.

  • :kms_key_id (String) —

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

  • :name (required, String) —

    The name of the Earth Observation job.

  • :tags (Hash<String,String>) —

    Each tag consists of a key and a value.

Returns:

See Also:



1410
1411
1412
1413
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1410

def start_earth_observation_job(params = {}, options = {})
  req = build_request(:start_earth_observation_job, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.start_vector_enrichment_job({
  client_token: "String",
  execution_role_arn: "String", # required
  input_config: { # required
    data_source_config: { # required
      s3_data: {
        kms_key_id: "String",
        s3_uri: "String", # required
      },
    },
    document_type: "CSV", # required, accepts CSV
  },
  job_config: { # required
    map_matching_config: {
      id_attribute_name: "String", # required
      timestamp_attribute_name: "String", # required
      x_attribute_name: "String", # required
      y_attribute_name: "String", # required
    },
    reverse_geocoding_config: {
      x_attribute_name: "String", # required
      y_attribute_name: "String", # required
    },
  },
  kms_key_id: "String",
  name: "String", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.duration_in_seconds #=> Integer
resp.execution_role_arn #=> String
resp.input_config.data_source_config.s3_data.kms_key_id #=> String
resp.input_config.data_source_config.s3_data.s3_uri #=> String
resp.input_config.document_type #=> String, one of "CSV"
resp.job_config.map_matching_config.id_attribute_name #=> String
resp.job_config.map_matching_config.timestamp_attribute_name #=> String
resp.job_config.map_matching_config.x_attribute_name #=> String
resp.job_config.map_matching_config.y_attribute_name #=> String
resp.job_config.reverse_geocoding_config.x_attribute_name #=> String
resp.job_config.reverse_geocoding_config.y_attribute_name #=> String
resp.kms_key_id #=> String
resp.name #=> String
resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "STOPPED", "COMPLETED", "FAILED", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.type #=> String, one of "REVERSE_GEOCODING", "MAP_MATCHING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :execution_role_arn (required, String) —

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

  • :input_config (required, Types::VectorEnrichmentJobInputConfig) —

    Input configuration information for the Vector Enrichment job.

  • :job_config (required, Types::VectorEnrichmentJobConfig) —

    An object containing information about the job configuration.

  • :kms_key_id (String) —

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

  • :name (required, String) —

    The name of the Vector Enrichment job.

  • :tags (Hash<String,String>) —

    Each tag consists of a key and a value.

Returns:

See Also:



1518
1519
1520
1521
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1518

def start_vector_enrichment_job(params = {}, options = {})
  req = build_request(:start_vector_enrichment_job, params)
  req.send_request(options)
end

#stop_earth_observation_job(params = {}) ⇒ Struct

Use this operation to stop an existing earth observation job.

Examples:

Request syntax with placeholder values


resp = client.stop_earth_observation_job({
  arn: "EarthObservationJobArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1541
1542
1543
1544
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1541

def stop_earth_observation_job(params = {}, options = {})
  req = build_request(:stop_earth_observation_job, params)
  req.send_request(options)
end

#stop_vector_enrichment_job(params = {}) ⇒ Struct

Stops the Vector Enrichment job for a given job ARN.

Examples:

Request syntax with placeholder values


resp = client.stop_vector_enrichment_job({
  arn: "VectorEnrichmentJobArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1563
1564
1565
1566
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1563

def stop_vector_enrichment_job(params = {}, options = {})
  req = build_request(:stop_vector_enrichment_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

The resource you want to tag.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Hash<String,String>) —

    Each tag consists of a key and a value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1591
1592
1593
1594
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1591

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

The resource you want to untag.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["String"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    Keys of the tags you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1617
1618
1619
1620
 
# File 'gems/aws-sdk-sagemakergeospatial/lib/aws-sdk-sagemakergeospatial/client.rb', line 1617

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end