GetTile - Amazon SageMaker

GetTile

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

Request Syntax

GET /tile/z/x/y?Arn=Arn&ExecutionRoleArn=ExecutionRoleArn&ImageAssets=ImageAssets&ImageMask=ImageMask&OutputDataType=OutputDataType&OutputFormat=OutputFormat&PropertyFilters=PropertyFilters&Target=Target&TimeRangeFilter=TimeRangeFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Arn

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

Pattern: ^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}$

Required: Yes

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role that you specify.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+$

ImageAssets

The particular assets or bands to tile.

Array Members: Minimum number of 1 item.

Required: Yes

ImageMask

Determines whether or not to return a valid data mask.

OutputDataType

The output data type of the tile operation.

Valid Values: INT32 | FLOAT32 | INT16 | FLOAT64 | UINT16

OutputFormat

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

PropertyFilters

Property filters for the imagery to tile.

Target

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

Valid Values: INPUT | OUTPUT

Required: Yes

TimeRangeFilter

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

x

The x coordinate of the tile input.

Required: Yes

y

The y coordinate of the tile input.

Required: Yes

z

The z coordinate of the tile input.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 BinaryFile

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following as the HTTP body.

BinaryFile

The output binary file.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: