Skip to content

Type definitions#

Index > SageMakergeospatialcapabilities > Type definitions

Auto-generated documentation for SageMakergeospatialcapabilities type annotations stubs module mypy-boto3-sagemaker-geospatial.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

JobConfigInputUnionTypeDef#

# JobConfigInputUnionTypeDef definition

JobConfigInputUnionTypeDef = Union[
    JobConfigInputTypeDef,  # (1)
    JobConfigInputOutputTypeDef,  # (2)
]
  1. See JobConfigInputTypeDef
  2. See JobConfigInputOutputTypeDef

MultiPolygonGeometryInputOutputTypeDef#

# MultiPolygonGeometryInputOutputTypeDef definition

class MultiPolygonGeometryInputOutputTypeDef(TypedDict):
    Coordinates: List[List[List[List[float]]]],

PolygonGeometryInputOutputTypeDef#

# PolygonGeometryInputOutputTypeDef definition

class PolygonGeometryInputOutputTypeDef(TypedDict):
    Coordinates: List[List[List[float]]],

MultiPolygonGeometryInputTypeDef#

# MultiPolygonGeometryInputTypeDef definition

class MultiPolygonGeometryInputTypeDef(TypedDict):
    Coordinates: Sequence[Sequence[Sequence[Sequence[float]]]],

PolygonGeometryInputTypeDef#

# PolygonGeometryInputTypeDef definition

class PolygonGeometryInputTypeDef(TypedDict):
    Coordinates: Sequence[Sequence[Sequence[float]]],

AssetValueTypeDef#

# AssetValueTypeDef definition

class AssetValueTypeDef(TypedDict):
    Href: NotRequired[str],

CloudRemovalConfigInputOutputTypeDef#

# CloudRemovalConfigInputOutputTypeDef definition

class CloudRemovalConfigInputOutputTypeDef(TypedDict):
    AlgorithmName: NotRequired[AlgorithmNameCloudRemovalType],  # (1)
    InterpolationValue: NotRequired[str],
    TargetBands: NotRequired[List[str]],
  1. See AlgorithmNameCloudRemovalType

CloudRemovalConfigInputTypeDef#

# CloudRemovalConfigInputTypeDef definition

class CloudRemovalConfigInputTypeDef(TypedDict):
    AlgorithmName: NotRequired[AlgorithmNameCloudRemovalType],  # (1)
    InterpolationValue: NotRequired[str],
    TargetBands: NotRequired[Sequence[str]],
  1. See AlgorithmNameCloudRemovalType

OperationTypeDef#

# OperationTypeDef definition

class OperationTypeDef(TypedDict):
    Equation: str,
    Name: str,
    OutputType: NotRequired[OutputTypeType],  # (1)
  1. See OutputTypeType

DeleteEarthObservationJobInputRequestTypeDef#

# DeleteEarthObservationJobInputRequestTypeDef definition

class DeleteEarthObservationJobInputRequestTypeDef(TypedDict):
    Arn: str,

DeleteVectorEnrichmentJobInputRequestTypeDef#

# DeleteVectorEnrichmentJobInputRequestTypeDef definition

class DeleteVectorEnrichmentJobInputRequestTypeDef(TypedDict):
    Arn: str,

EarthObservationJobErrorDetailsTypeDef#

# EarthObservationJobErrorDetailsTypeDef definition

class EarthObservationJobErrorDetailsTypeDef(TypedDict):
    Message: NotRequired[str],
    Type: NotRequired[EarthObservationJobErrorTypeType],  # (1)
  1. See EarthObservationJobErrorTypeType

EoCloudCoverInputTypeDef#

# EoCloudCoverInputTypeDef definition

class EoCloudCoverInputTypeDef(TypedDict):
    LowerBound: float,
    UpperBound: float,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ExportErrorDetailsOutputTypeDef#

# ExportErrorDetailsOutputTypeDef definition

class ExportErrorDetailsOutputTypeDef(TypedDict):
    Message: NotRequired[str],
    Type: NotRequired[ExportErrorTypeType],  # (1)
  1. See ExportErrorTypeType

ExportS3DataInputTypeDef#

# ExportS3DataInputTypeDef definition

class ExportS3DataInputTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: NotRequired[str],

VectorEnrichmentJobS3DataTypeDef#

# VectorEnrichmentJobS3DataTypeDef definition

class VectorEnrichmentJobS3DataTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: NotRequired[str],

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Name: str,
    Type: str,
    Maximum: NotRequired[float],
    Minimum: NotRequired[float],

GeoMosaicConfigInputOutputTypeDef#

# GeoMosaicConfigInputOutputTypeDef definition

class GeoMosaicConfigInputOutputTypeDef(TypedDict):
    AlgorithmName: NotRequired[AlgorithmNameGeoMosaicType],  # (1)
    TargetBands: NotRequired[List[str]],
  1. See AlgorithmNameGeoMosaicType

GeoMosaicConfigInputTypeDef#

# GeoMosaicConfigInputTypeDef definition

class GeoMosaicConfigInputTypeDef(TypedDict):
    AlgorithmName: NotRequired[AlgorithmNameGeoMosaicType],  # (1)
    TargetBands: NotRequired[Sequence[str]],
  1. See AlgorithmNameGeoMosaicType

GeometryTypeDef#

# GeometryTypeDef definition

class GeometryTypeDef(TypedDict):
    Coordinates: List[List[List[float]]],
    Type: str,

GetEarthObservationJobInputRequestTypeDef#

# GetEarthObservationJobInputRequestTypeDef definition

class GetEarthObservationJobInputRequestTypeDef(TypedDict):
    Arn: str,

OutputBandTypeDef#

# OutputBandTypeDef definition

class OutputBandTypeDef(TypedDict):
    BandName: str,
    OutputDataType: OutputTypeType,  # (1)
  1. See OutputTypeType

GetRasterDataCollectionInputRequestTypeDef#

# GetRasterDataCollectionInputRequestTypeDef definition

class GetRasterDataCollectionInputRequestTypeDef(TypedDict):
    Arn: str,

GetTileInputRequestTypeDef#

# GetTileInputRequestTypeDef definition

class GetTileInputRequestTypeDef(TypedDict):
    Arn: str,
    ImageAssets: Sequence[str],
    Target: TargetOptionsType,  # (1)
    x: int,
    y: int,
    z: int,
    ExecutionRoleArn: NotRequired[str],
    ImageMask: NotRequired[bool],
    OutputDataType: NotRequired[OutputTypeType],  # (2)
    OutputFormat: NotRequired[str],
    PropertyFilters: NotRequired[str],
    TimeRangeFilter: NotRequired[str],
  1. See TargetOptionsType
  2. See OutputTypeType

GetVectorEnrichmentJobInputRequestTypeDef#

# GetVectorEnrichmentJobInputRequestTypeDef definition

class GetVectorEnrichmentJobInputRequestTypeDef(TypedDict):
    Arn: str,

VectorEnrichmentJobErrorDetailsTypeDef#

# VectorEnrichmentJobErrorDetailsTypeDef definition

class VectorEnrichmentJobErrorDetailsTypeDef(TypedDict):
    ErrorMessage: NotRequired[str],
    ErrorType: NotRequired[VectorEnrichmentJobErrorTypeType],  # (1)
  1. See VectorEnrichmentJobErrorTypeType

VectorEnrichmentJobExportErrorDetailsTypeDef#

# VectorEnrichmentJobExportErrorDetailsTypeDef definition

class VectorEnrichmentJobExportErrorDetailsTypeDef(TypedDict):
    Message: NotRequired[str],
    Type: NotRequired[VectorEnrichmentJobExportErrorTypeType],  # (1)
  1. See VectorEnrichmentJobExportErrorTypeType

PropertiesTypeDef#

# PropertiesTypeDef definition

class PropertiesTypeDef(TypedDict):
    EoCloudCover: NotRequired[float],
    LandsatCloudCoverLand: NotRequired[float],
    Platform: NotRequired[str],
    ViewOffNadir: NotRequired[float],
    ViewSunAzimuth: NotRequired[float],
    ViewSunElevation: NotRequired[float],

TemporalStatisticsConfigInputOutputTypeDef#

# TemporalStatisticsConfigInputOutputTypeDef definition

class TemporalStatisticsConfigInputOutputTypeDef(TypedDict):
    Statistics: List[TemporalStatisticsType],  # (2)
    GroupBy: NotRequired[GroupByType],  # (1)
    TargetBands: NotRequired[List[str]],
  1. See GroupByType
  2. See TemporalStatisticsType

ZonalStatisticsConfigInputOutputTypeDef#

# ZonalStatisticsConfigInputOutputTypeDef definition

class ZonalStatisticsConfigInputOutputTypeDef(TypedDict):
    Statistics: List[ZonalStatisticsType],  # (1)
    ZoneS3Path: str,
    TargetBands: NotRequired[List[str]],
    ZoneS3PathKmsKeyId: NotRequired[str],
  1. See ZonalStatisticsType

TemporalStatisticsConfigInputTypeDef#

# TemporalStatisticsConfigInputTypeDef definition

class TemporalStatisticsConfigInputTypeDef(TypedDict):
    Statistics: Sequence[TemporalStatisticsType],  # (2)
    GroupBy: NotRequired[GroupByType],  # (1)
    TargetBands: NotRequired[Sequence[str]],
  1. See GroupByType
  2. See TemporalStatisticsType

ZonalStatisticsConfigInputTypeDef#

# ZonalStatisticsConfigInputTypeDef definition

class ZonalStatisticsConfigInputTypeDef(TypedDict):
    Statistics: Sequence[ZonalStatisticsType],  # (1)
    ZoneS3Path: str,
    TargetBands: NotRequired[Sequence[str]],
    ZoneS3PathKmsKeyId: NotRequired[str],
  1. See ZonalStatisticsType

LandsatCloudCoverLandInputTypeDef#

# LandsatCloudCoverLandInputTypeDef definition

class LandsatCloudCoverLandInputTypeDef(TypedDict):
    LowerBound: float,
    UpperBound: float,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListEarthObservationJobInputRequestTypeDef#

# ListEarthObservationJobInputRequestTypeDef definition

class ListEarthObservationJobInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SortBy: NotRequired[str],
    SortOrder: NotRequired[SortOrderType],  # (1)
    StatusEquals: NotRequired[EarthObservationJobStatusType],  # (2)
  1. See SortOrderType
  2. See EarthObservationJobStatusType

ListEarthObservationJobOutputConfigTypeDef#

# ListEarthObservationJobOutputConfigTypeDef definition

class ListEarthObservationJobOutputConfigTypeDef(TypedDict):
    Arn: str,
    CreationTime: datetime,
    DurationInSeconds: int,
    Name: str,
    OperationType: str,
    Status: EarthObservationJobStatusType,  # (1)
    Tags: NotRequired[Dict[str, str]],
  1. See EarthObservationJobStatusType

ListRasterDataCollectionsInputRequestTypeDef#

# ListRasterDataCollectionsInputRequestTypeDef definition

class ListRasterDataCollectionsInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListVectorEnrichmentJobInputRequestTypeDef#

# ListVectorEnrichmentJobInputRequestTypeDef definition

class ListVectorEnrichmentJobInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SortBy: NotRequired[str],
    SortOrder: NotRequired[SortOrderType],  # (1)
    StatusEquals: NotRequired[str],
  1. See SortOrderType