SageMakergeospatialcapabilities / Client / get_tile

get_tile#

SageMakergeospatialcapabilities.Client.get_tile(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_tile(
    Arn='string',
    ExecutionRoleArn='string',
    ImageAssets=[
        'string',
    ],
    ImageMask=True|False,
    OutputDataType='INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16',
    OutputFormat='string',
    PropertyFilters='string',
    Target='INPUT'|'OUTPUT',
    TimeRangeFilter='string',
    x=123,
    y=123,
    z=123
)
Parameters:

  • Arn (string) –

    [REQUIRED]

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

  • ExecutionRoleArn (string) – The Amazon Resource Name (ARN) of the IAM role that you specify.

  • ImageAssets (list) –

    [REQUIRED]

    The particular assets or bands to tile.

    • (string) –

  • ImageMask (boolean) – Determines whether or not to return a valid data mask.

  • OutputDataType (string) – The output data type of the tile operation.

  • OutputFormat (string) – The data format of the output tile. The formats include .npy, .png and .jpg.

  • PropertyFilters (string) – Property filters for the imagery to tile.

  • Target (string) –

    [REQUIRED]

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

  • TimeRangeFilter (string) – Time range filter applied to imagery to find the images to tile.

  • x (integer) –

    [REQUIRED]

    The x coordinate of the tile input.

  • y (integer) –

    [REQUIRED]

    The y coordinate of the tile input.

  • z (integer) –

    [REQUIRED]

    The z coordinate of the tile input.

Return type:

dict

Returns:

Response Syntax

{
    'BinaryFile': StreamingBody()
}

Response Structure

  • (dict) –

    • BinaryFile (StreamingBody) –

      The output binary file.

Exceptions