Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMakerGeoSpatial.GetTile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data GetTile = GetTile' {
- imageMask :: Maybe Bool
- outputDataType :: Maybe OutputType
- outputFormat :: Maybe Text
- propertyFilters :: Maybe Text
- timeRangeFilter :: Maybe Text
- arn :: Text
- imageAssets :: NonEmpty Text
- target :: TargetOptions
- x :: Int
- y :: Int
- z :: Int
}
newGetTile :: Text -> NonEmpty Text -> TargetOptions -> Int -> Int -> Int -> GetTile
getTile_imageMask :: Lens' GetTile (Maybe Bool)
getTile_outputDataType :: Lens' GetTile (Maybe OutputType)
getTile_outputFormat :: Lens' GetTile (Maybe Text)
getTile_propertyFilters :: Lens' GetTile (Maybe Text)
getTile_timeRangeFilter :: Lens' GetTile (Maybe Text)
getTile_arn :: Lens' GetTile Text
getTile_imageAssets :: Lens' GetTile (NonEmpty Text)
getTile_target :: Lens' GetTile TargetOptions
getTile_x :: Lens' GetTile Int
getTile_y :: Lens' GetTile Int
getTile_z :: Lens' GetTile Int
data GetTileResponse = GetTileResponse' {
- httpStatus :: Int
- binaryFile :: ResponseBody
}
newGetTileResponse :: Int -> ResponseBody -> GetTileResponse
getTileResponse_httpStatus :: Lens' GetTileResponse Int
getTileResponse_binaryFile :: Lens' GetTileResponse ResponseBody

Creating a Request

data GetTile Source #

See: newGetTile smart constructor.

Constructors

GetTile'

Fields

imageMask :: Maybe Bool
Determines whether or not to return a valid data mask.
outputDataType :: Maybe OutputType
The output data type of the tile operation.
outputFormat :: Maybe Text
The data format of the output tile. The formats include .npy, .png and .jpg.
propertyFilters :: Maybe Text
Property filters for the imagery to tile.
timeRangeFilter :: Maybe Text
Time range filter applied to imagery to find the images to tile.
arn :: Text
The Amazon Resource Name (ARN) of the tile operation.
imageAssets :: NonEmpty Text
The particular assets or bands to tile.
target :: TargetOptions
Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
x :: Int
The x coordinate of the tile input.
y :: Int
The y coordinate of the tile input.
z :: Int
The z coordinate of the tile input.

Instances

Instances details

ToHeaders GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods toHeaders :: GetTile -> [Header] #
ToPath GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods toPath :: GetTile -> ByteString #
ToQuery GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods toQuery :: GetTile -> QueryString #
AWSRequest GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Associated Types type AWSResponse GetTile # Methods request :: (Service -> Service) -> GetTile -> Request GetTile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTile))) #
Generic GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Associated Types type Rep GetTile :: Type -> Type # Methods from :: GetTile -> Rep GetTile x # to :: Rep GetTile x -> GetTile #
Read GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods readsPrec :: Int -> ReadS GetTile # readList :: ReadS [GetTile] # readPrec :: ReadPrec GetTile # readListPrec :: ReadPrec [GetTile] #
Show GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods showsPrec :: Int -> GetTile -> ShowS # show :: GetTile -> String # showList :: [GetTile] -> ShowS #
NFData GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods rnf :: GetTile -> () #
Eq GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods (==) :: GetTile -> GetTile -> Bool # (/=) :: GetTile -> GetTile -> Bool #
Hashable GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods hashWithSalt :: Int -> GetTile -> Int # hash :: GetTile -> Int #
type AWSResponse GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile type AWSResponse GetTile = GetTileResponse
type Rep GetTile Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile type Rep GetTile = D1 ('MetaData "GetTile" "Amazonka.SageMakerGeoSpatial.GetTile" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "GetTile'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "imageMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "outputDataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputType))) :: (S1 ('MetaSel ('Just "outputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "propertyFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "timeRangeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "imageAssets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TargetOptions))) :: (S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "z") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetTile Source #

Arguments

:: Text	`GetTile`
-> NonEmpty Text	`$sel:imageAssets:GetTile'`
-> TargetOptions	`$sel:target:GetTile'`
-> Int	`$sel:x:GetTile'`
-> Int	`$sel:y:GetTile'`
-> Int	`$sel:z:GetTile'`
-> GetTile

Create a value of GetTile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:imageMask:GetTile', getTile_imageMask - Determines whether or not to return a valid data mask.

GetTile, getTile_outputDataType - The output data type of the tile operation.

$sel:outputFormat:GetTile', getTile_outputFormat - The data format of the output tile. The formats include .npy, .png and .jpg.

GetTile, getTile_propertyFilters - Property filters for the imagery to tile.

GetTile, getTile_timeRangeFilter - Time range filter applied to imagery to find the images to tile.

GetTile, getTile_arn - The Amazon Resource Name (ARN) of the tile operation.

$sel:imageAssets:GetTile', getTile_imageAssets - The particular assets or bands to tile.

$sel:target:GetTile', getTile_target - Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.

$sel:x:GetTile', getTile_x - The x coordinate of the tile input.

$sel:y:GetTile', getTile_y - The y coordinate of the tile input.

$sel:z:GetTile', getTile_z - The z coordinate of the tile input.

Request Lenses

getTile_imageMask :: Lens' GetTile (Maybe Bool) Source #

Determines whether or not to return a valid data mask.

getTile_outputDataType :: Lens' GetTile (Maybe OutputType) Source #

The output data type of the tile operation.

getTile_outputFormat :: Lens' GetTile (Maybe Text) Source #

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

getTile_propertyFilters :: Lens' GetTile (Maybe Text) Source #

Property filters for the imagery to tile.

getTile_timeRangeFilter :: Lens' GetTile (Maybe Text) Source #

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

getTile_arn :: Lens' GetTile Text Source #

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

getTile_imageAssets :: Lens' GetTile (NonEmpty Text) Source #

The particular assets or bands to tile.

getTile_target :: Lens' GetTile TargetOptions Source #

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

getTile_x :: Lens' GetTile Int Source #

The x coordinate of the tile input.

getTile_y :: Lens' GetTile Int Source #

The y coordinate of the tile input.

getTile_z :: Lens' GetTile Int Source #

The z coordinate of the tile input.

Destructuring the Response

data GetTileResponse Source #

See: newGetTileResponse smart constructor.

Constructors

GetTileResponse'
Fields httpStatus :: Int The response's http status code. binaryFile :: ResponseBody The output binary file.

Instances

Instances details

Generic GetTileResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Associated Types type Rep GetTileResponse :: Type -> Type # Methods from :: GetTileResponse -> Rep GetTileResponse x # to :: Rep GetTileResponse x -> GetTileResponse #
Show GetTileResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile Methods showsPrec :: Int -> GetTileResponse -> ShowS # show :: GetTileResponse -> String # showList :: [GetTileResponse] -> ShowS #
type Rep GetTileResponse Source #
Instance details Defined in Amazonka.SageMakerGeoSpatial.GetTile type Rep GetTileResponse = D1 ('MetaData "GetTileResponse" "Amazonka.SageMakerGeoSpatial.GetTile" "amazonka-sagemaker-geospatial-2.0-Fg7YtbyXAZrLwLaIITXFtu" 'False) (C1 ('MetaCons "GetTileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "binaryFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResponseBody)))

newGetTileResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetTileResponse'`
-> ResponseBody	`$sel:binaryFile:GetTileResponse'`
-> GetTileResponse

Create a value of GetTileResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:GetTileResponse', getTileResponse_httpStatus - The response's http status code.

$sel:binaryFile:GetTileResponse', getTileResponse_binaryFile - The output binary file.

Response Lenses

getTileResponse_httpStatus :: Lens' GetTileResponse Int Source #

The response's http status code.

getTileResponse_binaryFile :: Lens' GetTileResponse ResponseBody Source #

The output binary file.