:doc:`SageMakergeospatialcapabilities <../../sagemaker-geospatial>` / Client / get_tile

********
get_tile
********



.. py:method:: SageMakergeospatialcapabilities.Client.get_tile(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/GetTile>`_  


  **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
    )
    
  :type Arn: string
  :param Arn: **[REQUIRED]** 

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

    

  
  :type ExecutionRoleArn: string
  :param ExecutionRoleArn: 

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

    

  
  :type ImageAssets: list
  :param ImageAssets: **[REQUIRED]** 

    The particular assets or bands to tile.

    

  
    - *(string) --* 

    

  :type ImageMask: boolean
  :param ImageMask: 

    Determines whether or not to return a valid data mask.

    

  
  :type OutputDataType: string
  :param OutputDataType: 

    The output data type of the tile operation.

    

  
  :type OutputFormat: string
  :param OutputFormat: 

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

    

  
  :type PropertyFilters: string
  :param PropertyFilters: 

    Property filters for the imagery to tile.

    

  
  :type Target: string
  :param Target: **[REQUIRED]** 

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

    

  
  :type TimeRangeFilter: string
  :param TimeRangeFilter: 

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

    

  
  :type x: integer
  :param x: **[REQUIRED]** 

    The x coordinate of the tile input.

    

  
  :type y: integer
  :param y: **[REQUIRED]** 

    The y coordinate of the tile input.

    

  
  :type z: integer
  :param z: **[REQUIRED]** 

    The z coordinate of the tile input.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'BinaryFile': StreamingBody()
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **BinaryFile** (:class:`.StreamingBody`) -- 

        The output binary file.

        
  
  **Exceptions**
  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ValidationException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.InternalServerException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException`

  