Client

sagemakergeospatialcapabilities

R Documentation

Amazon SageMaker geospatial capabilities¶

Description¶

Provides APIs for creating and managing SageMaker geospatial resources.

Usage¶

sagemakergeospatialcapabilities(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- sagemakergeospatialcapabilities(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

delete_earth_observation_job: Use this operation to delete an Earth Observation job
delete_vector_enrichment_job: Use this operation to delete a Vector Enrichment job
export_earth_observation_job: 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: Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location
get_earth_observation_job: Get the details for a previously initiated Earth Observation job
get_raster_data_collection: Use this operation to get details of a specific raster data collection
get_tile: Gets a web mercator tile for the given Earth Observation job
get_vector_enrichment_job: Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN)
list_earth_observation_jobs: Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account
list_raster_data_collections: Use this operation to get raster data collections
list_tags_for_resource: Lists the tags attached to the resource
list_vector_enrichment_jobs: Retrieves a list of vector enrichment jobs
search_raster_data_collection: 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: Use this operation to create an Earth observation job
start_vector_enrichment_job: Creates a Vector Enrichment job for the supplied job type
stop_earth_observation_job: Use this operation to stop an existing earth observation job
stop_vector_enrichment_job: Stops the Vector Enrichment job for a given job ARN
tag_resource: The resource you want to tag
untag_resource: The resource you want to untag

Examples¶

## Not run: 
svc <- sagemakergeospatialcapabilities()
svc$delete_earth_observation_job(
  Foo = 123
)

## End(Not run)