123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617 |
- import {Request} from '../lib/request';
- import {Response} from '../lib/response';
- import {AWSError} from '../lib/error';
- import {Service} from '../lib/service';
- import {ServiceConfigurationOptions} from '../lib/service';
- import {ConfigBase as Config} from '../lib/config-base';
- import {Readable} from 'stream';
- interface Blob {}
- declare class SageMakerGeospatial extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: SageMakerGeospatial.Types.ClientConfiguration)
- config: Config & SageMakerGeospatial.Types.ClientConfiguration;
- /**
- * Use this operation to delete an Earth Observation job.
- */
- deleteEarthObservationJob(params: SageMakerGeospatial.Types.DeleteEarthObservationJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.DeleteEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.DeleteEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to delete an Earth Observation job.
- */
- deleteEarthObservationJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.DeleteEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.DeleteEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to delete a Vector Enrichment job.
- */
- deleteVectorEnrichmentJob(params: SageMakerGeospatial.Types.DeleteVectorEnrichmentJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.DeleteVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.DeleteVectorEnrichmentJobOutput, AWSError>;
- /**
- * Use this operation to delete a Vector Enrichment job.
- */
- deleteVectorEnrichmentJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.DeleteVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.DeleteVectorEnrichmentJobOutput, AWSError>;
- /**
- * Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
- */
- exportEarthObservationJob(params: SageMakerGeospatial.Types.ExportEarthObservationJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.ExportEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.ExportEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
- */
- exportEarthObservationJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.ExportEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.ExportEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
- */
- exportVectorEnrichmentJob(params: SageMakerGeospatial.Types.ExportVectorEnrichmentJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.ExportVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.ExportVectorEnrichmentJobOutput, AWSError>;
- /**
- * Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
- */
- exportVectorEnrichmentJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.ExportVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.ExportVectorEnrichmentJobOutput, AWSError>;
- /**
- * Get the details for a previously initiated Earth Observation job.
- */
- getEarthObservationJob(params: SageMakerGeospatial.Types.GetEarthObservationJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.GetEarthObservationJobOutput, AWSError>;
- /**
- * Get the details for a previously initiated Earth Observation job.
- */
- getEarthObservationJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.GetEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to get details of a specific raster data collection.
- */
- getRasterDataCollection(params: SageMakerGeospatial.Types.GetRasterDataCollectionInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetRasterDataCollectionOutput) => void): Request<SageMakerGeospatial.Types.GetRasterDataCollectionOutput, AWSError>;
- /**
- * Use this operation to get details of a specific raster data collection.
- */
- getRasterDataCollection(callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetRasterDataCollectionOutput) => void): Request<SageMakerGeospatial.Types.GetRasterDataCollectionOutput, AWSError>;
- /**
- * Gets a web mercator tile for the given Earth Observation job.
- */
- getTile(params: SageMakerGeospatial.Types.GetTileInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetTileOutput) => void): Request<SageMakerGeospatial.Types.GetTileOutput, AWSError>;
- /**
- * Gets a web mercator tile for the given Earth Observation job.
- */
- getTile(callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetTileOutput) => void): Request<SageMakerGeospatial.Types.GetTileOutput, AWSError>;
- /**
- * Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
- */
- getVectorEnrichmentJob(params: SageMakerGeospatial.Types.GetVectorEnrichmentJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.GetVectorEnrichmentJobOutput, AWSError>;
- /**
- * Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
- */
- getVectorEnrichmentJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.GetVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.GetVectorEnrichmentJobOutput, AWSError>;
- /**
- * Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
- */
- listEarthObservationJobs(params: SageMakerGeospatial.Types.ListEarthObservationJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.ListEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
- */
- listEarthObservationJobs(callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.ListEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to get raster data collections.
- */
- listRasterDataCollections(params: SageMakerGeospatial.Types.ListRasterDataCollectionsInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListRasterDataCollectionsOutput) => void): Request<SageMakerGeospatial.Types.ListRasterDataCollectionsOutput, AWSError>;
- /**
- * Use this operation to get raster data collections.
- */
- listRasterDataCollections(callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListRasterDataCollectionsOutput) => void): Request<SageMakerGeospatial.Types.ListRasterDataCollectionsOutput, AWSError>;
- /**
- * Lists the tags attached to the resource.
- */
- listTagsForResource(params: SageMakerGeospatial.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListTagsForResourceResponse) => void): Request<SageMakerGeospatial.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Lists the tags attached to the resource.
- */
- listTagsForResource(callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListTagsForResourceResponse) => void): Request<SageMakerGeospatial.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Retrieves a list of vector enrichment jobs.
- */
- listVectorEnrichmentJobs(params: SageMakerGeospatial.Types.ListVectorEnrichmentJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.ListVectorEnrichmentJobOutput, AWSError>;
- /**
- * Retrieves a list of vector enrichment jobs.
- */
- listVectorEnrichmentJobs(callback?: (err: AWSError, data: SageMakerGeospatial.Types.ListVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.ListVectorEnrichmentJobOutput, AWSError>;
- /**
- * Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
- */
- searchRasterDataCollection(params: SageMakerGeospatial.Types.SearchRasterDataCollectionInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.SearchRasterDataCollectionOutput) => void): Request<SageMakerGeospatial.Types.SearchRasterDataCollectionOutput, AWSError>;
- /**
- * Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
- */
- searchRasterDataCollection(callback?: (err: AWSError, data: SageMakerGeospatial.Types.SearchRasterDataCollectionOutput) => void): Request<SageMakerGeospatial.Types.SearchRasterDataCollectionOutput, AWSError>;
- /**
- * Use this operation to create an Earth observation job.
- */
- startEarthObservationJob(params: SageMakerGeospatial.Types.StartEarthObservationJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.StartEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.StartEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to create an Earth observation job.
- */
- startEarthObservationJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.StartEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.StartEarthObservationJobOutput, AWSError>;
- /**
- * Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
- */
- startVectorEnrichmentJob(params: SageMakerGeospatial.Types.StartVectorEnrichmentJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.StartVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.StartVectorEnrichmentJobOutput, AWSError>;
- /**
- * Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
- */
- startVectorEnrichmentJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.StartVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.StartVectorEnrichmentJobOutput, AWSError>;
- /**
- * Use this operation to stop an existing earth observation job.
- */
- stopEarthObservationJob(params: SageMakerGeospatial.Types.StopEarthObservationJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.StopEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.StopEarthObservationJobOutput, AWSError>;
- /**
- * Use this operation to stop an existing earth observation job.
- */
- stopEarthObservationJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.StopEarthObservationJobOutput) => void): Request<SageMakerGeospatial.Types.StopEarthObservationJobOutput, AWSError>;
- /**
- * Stops the Vector Enrichment job for a given job ARN.
- */
- stopVectorEnrichmentJob(params: SageMakerGeospatial.Types.StopVectorEnrichmentJobInput, callback?: (err: AWSError, data: SageMakerGeospatial.Types.StopVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.StopVectorEnrichmentJobOutput, AWSError>;
- /**
- * Stops the Vector Enrichment job for a given job ARN.
- */
- stopVectorEnrichmentJob(callback?: (err: AWSError, data: SageMakerGeospatial.Types.StopVectorEnrichmentJobOutput) => void): Request<SageMakerGeospatial.Types.StopVectorEnrichmentJobOutput, AWSError>;
- /**
- * The resource you want to tag.
- */
- tagResource(params: SageMakerGeospatial.Types.TagResourceRequest, callback?: (err: AWSError, data: SageMakerGeospatial.Types.TagResourceResponse) => void): Request<SageMakerGeospatial.Types.TagResourceResponse, AWSError>;
- /**
- * The resource you want to tag.
- */
- tagResource(callback?: (err: AWSError, data: SageMakerGeospatial.Types.TagResourceResponse) => void): Request<SageMakerGeospatial.Types.TagResourceResponse, AWSError>;
- /**
- * The resource you want to untag.
- */
- untagResource(params: SageMakerGeospatial.Types.UntagResourceRequest, callback?: (err: AWSError, data: SageMakerGeospatial.Types.UntagResourceResponse) => void): Request<SageMakerGeospatial.Types.UntagResourceResponse, AWSError>;
- /**
- * The resource you want to untag.
- */
- untagResource(callback?: (err: AWSError, data: SageMakerGeospatial.Types.UntagResourceResponse) => void): Request<SageMakerGeospatial.Types.UntagResourceResponse, AWSError>;
- }
- declare namespace SageMakerGeospatial {
- export type AlgorithmNameCloudRemoval = "INTERPOLATION"|string;
- export type AlgorithmNameGeoMosaic = "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM"|string;
- export type AlgorithmNameResampling = "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM"|string;
- export interface AreaOfInterest {
- /**
- * A GeoJSON object representing the geographic extent in the coordinate space.
- */
- AreaOfInterestGeometry?: AreaOfInterestGeometry;
- }
- export interface AreaOfInterestGeometry {
- /**
- * The structure representing the MultiPolygon Geometry.
- */
- MultiPolygonGeometry?: MultiPolygonGeometryInput;
- /**
- * The structure representing Polygon Geometry.
- */
- PolygonGeometry?: PolygonGeometryInput;
- }
- export type Arn = string;
- export interface AssetValue {
- /**
- * Link to the asset object.
- */
- Href?: String;
- }
- export type AssetsMap = {[key: string]: AssetValue};
- export interface BandMathConfigInput {
- /**
- * CustomIndices that are computed.
- */
- CustomIndices?: CustomIndicesInput;
- /**
- * One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.
- */
- PredefinedIndices?: StringListInput;
- }
- export type BinaryFile = Buffer|Uint8Array|Blob|string|Readable;
- export type Boolean = boolean;
- export interface CloudMaskingConfigInput {
- }
- export interface CloudRemovalConfigInput {
- /**
- * The name of the algorithm used for cloud removal.
- */
- AlgorithmName?: AlgorithmNameCloudRemoval;
- /**
- * The interpolation value you provide for cloud removal.
- */
- InterpolationValue?: String;
- /**
- * TargetBands to be returned in the output of CloudRemoval operation.
- */
- TargetBands?: StringListInput;
- }
- export type ComparisonOperator = "EQUALS"|"NOT_EQUALS"|"STARTS_WITH"|string;
- export interface CustomIndicesInput {
- /**
- * A list of BandMath indices to compute.
- */
- Operations?: OperationsListInput;
- }
- export type DataCollectionArn = string;
- export type DataCollectionType = "PUBLIC"|"PREMIUM"|"USER"|string;
- export type DataCollectionsList = RasterDataCollectionMetadata[];
- export interface DeleteEarthObservationJobInput {
- /**
- * The Amazon Resource Name (ARN) of the Earth Observation job being deleted.
- */
- Arn: EarthObservationJobArn;
- }
- export interface DeleteEarthObservationJobOutput {
- }
- export interface DeleteVectorEnrichmentJobInput {
- /**
- * The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.
- */
- Arn: VectorEnrichmentJobArn;
- }
- export interface DeleteVectorEnrichmentJobOutput {
- }
- export type Double = number;
- export type EarthObservationJobArn = string;
- export interface EarthObservationJobErrorDetails {
- /**
- * A detailed message describing the error in an Earth Observation job.
- */
- Message?: String;
- /**
- * The type of error in an Earth Observation job.
- */
- Type?: EarthObservationJobErrorType;
- }
- export type EarthObservationJobErrorType = "CLIENT_ERROR"|"SERVER_ERROR"|string;
- export type EarthObservationJobExportStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string;
- export type EarthObservationJobList = ListEarthObservationJobOutputConfig[];
- export type EarthObservationJobOutputBands = OutputBand[];
- export type EarthObservationJobStatus = "INITIALIZING"|"IN_PROGRESS"|"STOPPING"|"COMPLETED"|"STOPPED"|"FAILED"|"DELETING"|"DELETED"|string;
- export interface EoCloudCoverInput {
- /**
- * Lower bound for EoCloudCover.
- */
- LowerBound: Float;
- /**
- * Upper bound for EoCloudCover.
- */
- UpperBound: Float;
- }
- export type ExecutionRoleArn = string;
- export interface ExportEarthObservationJobInput {
- /**
- * The input Amazon Resource Name (ARN) of the Earth Observation job being exported.
- */
- Arn: EarthObservationJobArn;
- /**
- * A unique token that guarantees that the call to this API is idempotent.
- */
- ClientToken?: ExportEarthObservationJobInputClientTokenString;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * The source images provided to the Earth Observation job being exported.
- */
- ExportSourceImages?: Boolean;
- /**
- * An object containing information about the output file.
- */
- OutputConfig: OutputConfigInput;
- }
- export type ExportEarthObservationJobInputClientTokenString = string;
- export interface ExportEarthObservationJobOutput {
- /**
- * The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
- */
- Arn: EarthObservationJobArn;
- /**
- * The creation time.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * The source images provided to the Earth Observation job being exported.
- */
- ExportSourceImages?: Boolean;
- /**
- * The status of the results of the Earth Observation job being exported.
- */
- ExportStatus: EarthObservationJobExportStatus;
- /**
- * An object containing information about the output file.
- */
- OutputConfig: OutputConfigInput;
- }
- export interface ExportErrorDetails {
- /**
- * The structure for returning the export error details while exporting results of an Earth Observation job.
- */
- ExportResults?: ExportErrorDetailsOutput;
- /**
- * The structure for returning the export error details while exporting the source images of an Earth Observation job.
- */
- ExportSourceImages?: ExportErrorDetailsOutput;
- }
- export interface ExportErrorDetailsOutput {
- /**
- * A detailed message describing the error in an export EarthObservationJob operation.
- */
- Message?: String;
- /**
- * The type of error in an export EarthObservationJob operation.
- */
- Type?: ExportErrorType;
- }
- export type ExportErrorType = "CLIENT_ERROR"|"SERVER_ERROR"|string;
- export interface ExportS3DataInput {
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The URL to the Amazon S3 data input.
- */
- S3Uri: S3Uri;
- }
- export interface ExportVectorEnrichmentJobInput {
- /**
- * The Amazon Resource Name (ARN) of the Vector Enrichment job.
- */
- Arn: VectorEnrichmentJobArn;
- /**
- * A unique token that guarantees that the call to this API is idempotent.
- */
- ClientToken?: ExportVectorEnrichmentJobInputClientTokenString;
- /**
- * The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * Output location information for exporting Vector Enrichment Job results.
- */
- OutputConfig: ExportVectorEnrichmentJobOutputConfig;
- }
- export type ExportVectorEnrichmentJobInputClientTokenString = string;
- export interface ExportVectorEnrichmentJobOutput {
- /**
- * The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
- */
- Arn: VectorEnrichmentJobArn;
- /**
- * The creation time.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * The status of the results the Vector Enrichment job being exported.
- */
- ExportStatus: VectorEnrichmentJobExportStatus;
- /**
- * Output location information for exporting Vector Enrichment Job results.
- */
- OutputConfig: ExportVectorEnrichmentJobOutputConfig;
- }
- export interface ExportVectorEnrichmentJobOutputConfig {
- /**
- * The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.
- */
- S3Data: VectorEnrichmentJobS3Data;
- }
- export interface Filter {
- /**
- * The maximum value of the filter.
- */
- Maximum?: Float;
- /**
- * The minimum value of the filter.
- */
- Minimum?: Float;
- /**
- * The name of the filter.
- */
- Name: String;
- /**
- * The type of the filter being used.
- */
- Type: String;
- }
- export type FilterList = Filter[];
- export type Float = number;
- export interface GeoMosaicConfigInput {
- /**
- * The name of the algorithm being used for geomosaic.
- */
- AlgorithmName?: AlgorithmNameGeoMosaic;
- /**
- * The target bands for geomosaic.
- */
- TargetBands?: StringListInput;
- }
- export interface Geometry {
- /**
- * The coordinates of the GeoJson Geometry.
- */
- Coordinates: LinearRings;
- /**
- * GeoJson Geometry types like Polygon and MultiPolygon.
- */
- Type: String;
- }
- export interface GetEarthObservationJobInput {
- /**
- * The Amazon Resource Name (ARN) of the Earth Observation job.
- */
- Arn: EarthObservationJobArn;
- }
- export interface GetEarthObservationJobOutput {
- /**
- * The Amazon Resource Name (ARN) of the Earth Observation job.
- */
- Arn: String;
- /**
- * The creation time of the initiated Earth Observation job.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The duration of Earth Observation job, in seconds.
- */
- DurationInSeconds: Integer;
- /**
- * Details about the errors generated during the Earth Observation job.
- */
- ErrorDetails?: EarthObservationJobErrorDetails;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn?: ExecutionRoleArn;
- /**
- * Details about the errors generated during ExportEarthObservationJob.
- */
- ExportErrorDetails?: ExportErrorDetails;
- /**
- * The status of the Earth Observation job.
- */
- ExportStatus?: EarthObservationJobExportStatus;
- /**
- * Input data for the Earth Observation job.
- */
- InputConfig: InputConfigOutput;
- /**
- * An object containing information about the job configuration.
- */
- JobConfig: JobConfigInput;
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The name of the Earth Observation job.
- */
- Name: String;
- /**
- * Bands available in the output of an operation.
- */
- OutputBands?: EarthObservationJobOutputBands;
- /**
- * The status of a previously initiated Earth Observation job.
- */
- Status: EarthObservationJobStatus;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- }
- export interface GetRasterDataCollectionInput {
- /**
- * The Amazon Resource Name (ARN) of the raster data collection.
- */
- Arn: DataCollectionArn;
- }
- export interface GetRasterDataCollectionOutput {
- /**
- * The Amazon Resource Name (ARN) of the raster data collection.
- */
- Arn: DataCollectionArn;
- /**
- * A description of the raster data collection.
- */
- Description: String;
- /**
- * The URL of the description page.
- */
- DescriptionPageUrl: String;
- /**
- * The list of image source bands in the raster data collection.
- */
- ImageSourceBands: ImageSourceBandList;
- /**
- * The name of the raster data collection.
- */
- Name: String;
- /**
- * The filters supported by the raster data collection.
- */
- SupportedFilters: FilterList;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- /**
- * The raster data collection type.
- */
- Type: DataCollectionType;
- }
- export interface GetTileInput {
- /**
- * The Amazon Resource Name (ARN) of the tile operation.
- */
- Arn: EarthObservationJobArn;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specify.
- */
- ExecutionRoleArn?: ExecutionRoleArn;
- /**
- * The particular assets or bands to tile.
- */
- ImageAssets: StringListInput;
- /**
- * Determines whether or not to return a valid data mask.
- */
- ImageMask?: Boolean;
- /**
- * The output data type of the tile operation.
- */
- OutputDataType?: OutputType;
- /**
- * The data format of the output tile. The formats include .npy, .png and .jpg.
- */
- OutputFormat?: String;
- /**
- * Property filters for the imagery to tile.
- */
- PropertyFilters?: String;
- /**
- * Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
- */
- Target: TargetOptions;
- /**
- * Time range filter applied to imagery to find the images to tile.
- */
- TimeRangeFilter?: String;
- /**
- * The x coordinate of the tile input.
- */
- x: Integer;
- /**
- * The y coordinate of the tile input.
- */
- y: Integer;
- /**
- * The z coordinate of the tile input.
- */
- z: Integer;
- }
- export interface GetTileOutput {
- /**
- * The output binary file.
- */
- BinaryFile?: BinaryFile;
- }
- export interface GetVectorEnrichmentJobInput {
- /**
- * The Amazon Resource Name (ARN) of the Vector Enrichment job.
- */
- Arn: VectorEnrichmentJobArn;
- }
- export interface GetVectorEnrichmentJobOutput {
- /**
- * The Amazon Resource Name (ARN) of the Vector Enrichment job.
- */
- Arn: String;
- /**
- * The creation time.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The duration of the Vector Enrichment job, in seconds.
- */
- DurationInSeconds: Integer;
- /**
- * Details about the errors generated during the Vector Enrichment job.
- */
- ErrorDetails?: VectorEnrichmentJobErrorDetails;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * Details about the errors generated during the ExportVectorEnrichmentJob.
- */
- ExportErrorDetails?: VectorEnrichmentJobExportErrorDetails;
- /**
- * The export status of the Vector Enrichment job being initiated.
- */
- ExportStatus?: VectorEnrichmentJobExportStatus;
- /**
- * Input configuration information for the Vector Enrichment job.
- */
- InputConfig: VectorEnrichmentJobInputConfig;
- /**
- * An object containing information about the job configuration.
- */
- JobConfig: VectorEnrichmentJobConfig;
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The name of the Vector Enrichment job.
- */
- Name: String;
- /**
- * The status of the initiated Vector Enrichment job.
- */
- Status: VectorEnrichmentJobStatus;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- /**
- * The type of the Vector Enrichment job being initiated.
- */
- Type: VectorEnrichmentJobType;
- }
- export type GroupBy = "ALL"|"YEARLY"|string;
- export type ImageSourceBandList = String[];
- export interface InputConfigInput {
- /**
- * The Amazon Resource Name (ARN) of the previous Earth Observation job.
- */
- PreviousEarthObservationJobArn?: EarthObservationJobArn;
- /**
- * The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters.
- */
- RasterDataCollectionQuery?: RasterDataCollectionQueryInput;
- }
- export interface InputConfigOutput {
- /**
- * The Amazon Resource Name (ARN) of the previous Earth Observation job.
- */
- PreviousEarthObservationJobArn?: EarthObservationJobArn;
- /**
- * The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.
- */
- RasterDataCollectionQuery?: RasterDataCollectionQueryOutput;
- }
- export type Integer = number;
- export interface ItemSource {
- /**
- * This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.
- */
- Assets?: AssetsMap;
- /**
- * The searchable date and time of the item, in UTC.
- */
- DateTime: Timestamp;
- /**
- * The item Geometry in GeoJson format.
- */
- Geometry: Geometry;
- /**
- * A unique Id for the source item.
- */
- Id: String;
- /**
- * This field contains additional properties of the item.
- */
- Properties?: Properties;
- }
- export type ItemSourceList = ItemSource[];
- export interface JobConfigInput {
- /**
- * An object containing information about the job configuration for BandMath.
- */
- BandMathConfig?: BandMathConfigInput;
- /**
- * An object containing information about the job configuration for cloud masking.
- */
- CloudMaskingConfig?: CloudMaskingConfigInput;
- /**
- * An object containing information about the job configuration for cloud removal.
- */
- CloudRemovalConfig?: CloudRemovalConfigInput;
- /**
- * An object containing information about the job configuration for geomosaic.
- */
- GeoMosaicConfig?: GeoMosaicConfigInput;
- /**
- * An object containing information about the job configuration for land cover segmentation.
- */
- LandCoverSegmentationConfig?: LandCoverSegmentationConfigInput;
- /**
- * An object containing information about the job configuration for resampling.
- */
- ResamplingConfig?: ResamplingConfigInput;
- /**
- * An object containing information about the job configuration for a Stacking Earth Observation job.
- */
- StackConfig?: StackConfigInput;
- /**
- * An object containing information about the job configuration for temporal statistics.
- */
- TemporalStatisticsConfig?: TemporalStatisticsConfigInput;
- /**
- * An object containing information about the job configuration for zonal statistics.
- */
- ZonalStatisticsConfig?: ZonalStatisticsConfigInput;
- }
- export type KmsKey = string;
- export interface LandCoverSegmentationConfigInput {
- }
- export interface LandsatCloudCoverLandInput {
- /**
- * The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.
- */
- LowerBound: Float;
- /**
- * The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.
- */
- UpperBound: Float;
- }
- export type LinearRing = Position[];
- export type LinearRings = LinearRing[];
- export type LinearRingsList = LinearRings[];
- export interface ListEarthObservationJobInput {
- /**
- * The total number of items to return.
- */
- MaxResults?: ListEarthObservationJobInputMaxResultsInteger;
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- /**
- * The parameter by which to sort the results.
- */
- SortBy?: String;
- /**
- * An optional value that specifies whether you want the results sorted in Ascending or Descending order.
- */
- SortOrder?: SortOrder;
- /**
- * A filter that retrieves only jobs with a specific status.
- */
- StatusEquals?: EarthObservationJobStatus;
- }
- export type ListEarthObservationJobInputMaxResultsInteger = number;
- export interface ListEarthObservationJobOutput {
- /**
- * Contains summary information about the Earth Observation jobs.
- */
- EarthObservationJobSummaries: EarthObservationJobList;
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- }
- export interface ListEarthObservationJobOutputConfig {
- /**
- * The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.
- */
- Arn: String;
- /**
- * The creation time.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The duration of the session, in seconds.
- */
- DurationInSeconds: Integer;
- /**
- * The names of the Earth Observation jobs in the list.
- */
- Name: String;
- /**
- * The operation type for an Earth Observation job.
- */
- OperationType: String;
- /**
- * The status of the list of the Earth Observation jobs.
- */
- Status: EarthObservationJobStatus;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- }
- export interface ListRasterDataCollectionsInput {
- /**
- * The total number of items to return.
- */
- MaxResults?: ListRasterDataCollectionsInputMaxResultsInteger;
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- }
- export type ListRasterDataCollectionsInputMaxResultsInteger = number;
- export interface ListRasterDataCollectionsOutput {
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- /**
- * Contains summary information about the raster data collection.
- */
- RasterDataCollectionSummaries: DataCollectionsList;
- }
- export interface ListTagsForResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource you want to tag.
- */
- ResourceArn: Arn;
- }
- export interface ListTagsForResourceResponse {
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- }
- export interface ListVectorEnrichmentJobInput {
- /**
- * The maximum number of items to return.
- */
- MaxResults?: ListVectorEnrichmentJobInputMaxResultsInteger;
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- /**
- * The parameter by which to sort the results.
- */
- SortBy?: String;
- /**
- * An optional value that specifies whether you want the results sorted in Ascending or Descending order.
- */
- SortOrder?: SortOrder;
- /**
- * A filter that retrieves only jobs with a specific status.
- */
- StatusEquals?: String;
- }
- export type ListVectorEnrichmentJobInputMaxResultsInteger = number;
- export interface ListVectorEnrichmentJobOutput {
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- /**
- * Contains summary information about the Vector Enrichment jobs.
- */
- VectorEnrichmentJobSummaries: VectorEnrichmentJobList;
- }
- export interface ListVectorEnrichmentJobOutputConfig {
- /**
- * The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.
- */
- Arn: VectorEnrichmentJobArn;
- /**
- * The creation time.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The duration of the session, in seconds.
- */
- DurationInSeconds: Integer;
- /**
- * The names of the Vector Enrichment jobs in the list.
- */
- Name: String;
- /**
- * The status of the Vector Enrichment jobs list.
- */
- Status: VectorEnrichmentJobStatus;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- /**
- * The type of the list of Vector Enrichment jobs.
- */
- Type: VectorEnrichmentJobType;
- }
- export type LogicalOperator = "AND"|string;
- export interface MapMatchingConfig {
- /**
- * The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.
- */
- IdAttributeName: String;
- /**
- * The name of the timestamp attribute.
- */
- TimestampAttributeName: String;
- /**
- * The name of the X-attribute
- */
- XAttributeName: String;
- /**
- * The name of the Y-attribute
- */
- YAttributeName: String;
- }
- export interface MultiPolygonGeometryInput {
- /**
- * The coordinates of the multipolygon geometry.
- */
- Coordinates: LinearRingsList;
- }
- export type NextToken = string;
- export interface Operation {
- /**
- * Textual representation of the math operation; Equation used to compute the spectral index.
- */
- Equation: String;
- /**
- * The name of the operation.
- */
- Name: String;
- /**
- * The type of the operation.
- */
- OutputType?: OutputType;
- }
- export type OperationsListInput = Operation[];
- export interface OutputBand {
- /**
- * The name of the band.
- */
- BandName: String;
- /**
- * The datatype of the output band.
- */
- OutputDataType: OutputType;
- }
- export interface OutputConfigInput {
- /**
- * Path to Amazon S3 storage location for the output configuration file.
- */
- S3Data: ExportS3DataInput;
- }
- export interface OutputResolutionResamplingInput {
- /**
- * User Defined Resolution for the output of Resampling operation defined by value and unit.
- */
- UserDefined: UserDefined;
- }
- export interface OutputResolutionStackInput {
- /**
- * A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.
- */
- Predefined?: PredefinedResolution;
- /**
- * The structure representing User Output Resolution for a Stacking operation defined as a value and unit.
- */
- UserDefined?: UserDefined;
- }
- export type OutputType = "INT32"|"FLOAT32"|"INT16"|"FLOAT64"|"UINT16"|string;
- export interface PlatformInput {
- /**
- * The ComparisonOperator to use with PlatformInput.
- */
- ComparisonOperator?: ComparisonOperator;
- /**
- * The value of the platform.
- */
- Value: String;
- }
- export interface PolygonGeometryInput {
- /**
- * Coordinates representing a Polygon based on the GeoJson spec.
- */
- Coordinates: LinearRings;
- }
- export type Position = Double[];
- export type PredefinedResolution = "HIGHEST"|"LOWEST"|"AVERAGE"|string;
- export interface Properties {
- /**
- * Estimate of cloud cover.
- */
- EoCloudCover?: Float;
- /**
- * Land cloud cover for Landsat Data Collection.
- */
- LandsatCloudCoverLand?: Float;
- /**
- * Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
- */
- Platform?: String;
- /**
- * The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
- */
- ViewOffNadir?: Float;
- /**
- * The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
- */
- ViewSunAzimuth?: Float;
- /**
- * The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.
- */
- ViewSunElevation?: Float;
- }
- export interface Property {
- /**
- * The structure representing EoCloudCover property filter containing a lower bound and upper bound.
- */
- EoCloudCover?: EoCloudCoverInput;
- /**
- * The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.
- */
- LandsatCloudCoverLand?: LandsatCloudCoverLandInput;
- /**
- * The structure representing Platform property filter consisting of value and comparison operator.
- */
- Platform?: PlatformInput;
- /**
- * The structure representing ViewOffNadir property filter containing a lower bound and upper bound.
- */
- ViewOffNadir?: ViewOffNadirInput;
- /**
- * The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.
- */
- ViewSunAzimuth?: ViewSunAzimuthInput;
- /**
- * The structure representing ViewSunElevation property filter containing a lower bound and upper bound.
- */
- ViewSunElevation?: ViewSunElevationInput;
- }
- export interface PropertyFilter {
- /**
- * Represents a single property to match with when searching a raster data collection.
- */
- Property: Property;
- }
- export interface PropertyFilters {
- /**
- * The Logical Operator used to combine the Property Filters.
- */
- LogicalOperator?: LogicalOperator;
- /**
- * A list of Property Filters.
- */
- Properties?: PropertyFiltersList;
- }
- export type PropertyFiltersList = PropertyFilter[];
- export interface RasterDataCollectionMetadata {
- /**
- * The Amazon Resource Name (ARN) of the raster data collection.
- */
- Arn: DataCollectionArn;
- /**
- * A description of the raster data collection.
- */
- Description: String;
- /**
- * The description URL of the raster data collection.
- */
- DescriptionPageUrl?: String;
- /**
- * The name of the raster data collection.
- */
- Name: String;
- /**
- * The list of filters supported by the raster data collection.
- */
- SupportedFilters: FilterList;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- /**
- * The type of raster data collection.
- */
- Type: DataCollectionType;
- }
- export interface RasterDataCollectionQueryInput {
- /**
- * The area of interest being queried for the raster data collection.
- */
- AreaOfInterest?: AreaOfInterest;
- /**
- * The list of Property filters used in the Raster Data Collection Query.
- */
- PropertyFilters?: PropertyFilters;
- /**
- * The Amazon Resource Name (ARN) of the raster data collection.
- */
- RasterDataCollectionArn: DataCollectionArn;
- /**
- * The TimeRange Filter used in the RasterDataCollection Query.
- */
- TimeRangeFilter: TimeRangeFilterInput;
- }
- export interface RasterDataCollectionQueryOutput {
- /**
- * The Area of Interest used in the search.
- */
- AreaOfInterest?: AreaOfInterest;
- /**
- * Property filters used in the search.
- */
- PropertyFilters?: PropertyFilters;
- /**
- * The ARN of the Raster Data Collection against which the search is done.
- */
- RasterDataCollectionArn: DataCollectionArn;
- /**
- * The name of the raster data collection.
- */
- RasterDataCollectionName: String;
- /**
- * The TimeRange filter used in the search.
- */
- TimeRangeFilter: TimeRangeFilterOutput;
- }
- export interface RasterDataCollectionQueryWithBandFilterInput {
- /**
- * The Area of interest to be used in the search query.
- */
- AreaOfInterest?: AreaOfInterest;
- /**
- * The list of Bands to be displayed in the result for each item.
- */
- BandFilter?: StringListInput;
- /**
- * The Property Filters used in the search query.
- */
- PropertyFilters?: PropertyFilters;
- /**
- * The TimeRange Filter used in the search query.
- */
- TimeRangeFilter: TimeRangeFilterInput;
- }
- export interface ResamplingConfigInput {
- /**
- * The name of the algorithm used for resampling.
- */
- AlgorithmName?: AlgorithmNameResampling;
- /**
- * The structure representing output resolution (in target georeferenced units) of the result of resampling operation.
- */
- OutputResolution: OutputResolutionResamplingInput;
- /**
- * Bands used in the operation. If no target bands are specified, it uses all bands available in the input.
- */
- TargetBands?: StringListInput;
- }
- export interface ReverseGeocodingConfig {
- /**
- * The field name for the data that describes x-axis coordinate, eg. longitude of a point.
- */
- XAttributeName: String;
- /**
- * The field name for the data that describes y-axis coordinate, eg. latitude of a point.
- */
- YAttributeName: String;
- }
- export type S3Uri = string;
- export interface SearchRasterDataCollectionInput {
- /**
- * The Amazon Resource Name (ARN) of the raster data collection.
- */
- Arn: DataCollectionArn;
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- /**
- * RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.
- */
- RasterDataCollectionQuery: RasterDataCollectionQueryWithBandFilterInput;
- }
- export interface SearchRasterDataCollectionOutput {
- /**
- * Approximate number of results in the response.
- */
- ApproximateResultCount: Integer;
- /**
- * List of items matching the Raster DataCollectionQuery.
- */
- Items?: ItemSourceList;
- /**
- * If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- */
- NextToken?: NextToken;
- }
- export type SortOrder = "ASCENDING"|"DESCENDING"|string;
- export interface StackConfigInput {
- /**
- * The structure representing output resolution (in target georeferenced units) of the result of stacking operation.
- */
- OutputResolution?: OutputResolutionStackInput;
- /**
- * A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.
- */
- TargetBands?: StringListInput;
- }
- export interface StartEarthObservationJobInput {
- /**
- * A unique token that guarantees that the call to this API is idempotent.
- */
- ClientToken?: StartEarthObservationJobInputClientTokenString;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * Input configuration information for the Earth Observation job.
- */
- InputConfig: InputConfigInput;
- /**
- * An object containing information about the job configuration.
- */
- JobConfig: JobConfigInput;
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The name of the Earth Observation job.
- */
- Name: StartEarthObservationJobInputNameString;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- }
- export type StartEarthObservationJobInputClientTokenString = string;
- export type StartEarthObservationJobInputNameString = string;
- export interface StartEarthObservationJobOutput {
- /**
- * The Amazon Resource Name (ARN) of the Earth Observation job.
- */
- Arn: String;
- /**
- * The creation time.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The duration of the session, in seconds.
- */
- DurationInSeconds: Integer;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * Input configuration information for the Earth Observation job.
- */
- InputConfig?: InputConfigOutput;
- /**
- * An object containing information about the job configuration.
- */
- JobConfig: JobConfigInput;
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The name of the Earth Observation job.
- */
- Name: String;
- /**
- * The status of the Earth Observation job.
- */
- Status: EarthObservationJobStatus;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- }
- export interface StartVectorEnrichmentJobInput {
- /**
- * A unique token that guarantees that the call to this API is idempotent.
- */
- ClientToken?: StartVectorEnrichmentJobInputClientTokenString;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * Input configuration information for the Vector Enrichment job.
- */
- InputConfig: VectorEnrichmentJobInputConfig;
- /**
- * An object containing information about the job configuration.
- */
- JobConfig: VectorEnrichmentJobConfig;
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The name of the Vector Enrichment job.
- */
- Name: StartVectorEnrichmentJobInputNameString;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- }
- export type StartVectorEnrichmentJobInputClientTokenString = string;
- export type StartVectorEnrichmentJobInputNameString = string;
- export interface StartVectorEnrichmentJobOutput {
- /**
- * The Amazon Resource Name (ARN) of the Vector Enrichment job.
- */
- Arn: VectorEnrichmentJobArn;
- /**
- * The creation time.
- */
- CreationTime: SyntheticTimestamp_date_time;
- /**
- * The duration of the Vector Enrichment job, in seconds.
- */
- DurationInSeconds: Integer;
- /**
- * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- */
- ExecutionRoleArn: ExecutionRoleArn;
- /**
- * Input configuration information for starting the Vector Enrichment job.
- */
- InputConfig: VectorEnrichmentJobInputConfig;
- /**
- * An object containing information about the job configuration.
- */
- JobConfig: VectorEnrichmentJobConfig;
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The name of the Vector Enrichment job.
- */
- Name: String;
- /**
- * The status of the Vector Enrichment job being started.
- */
- Status: VectorEnrichmentJobStatus;
- /**
- * Each tag consists of a key and a value.
- */
- Tags?: Tags;
- /**
- * The type of the Vector Enrichment job.
- */
- Type: VectorEnrichmentJobType;
- }
- export interface StopEarthObservationJobInput {
- /**
- * The Amazon Resource Name (ARN) of the Earth Observation job being stopped.
- */
- Arn: EarthObservationJobArn;
- }
- export interface StopEarthObservationJobOutput {
- }
- export interface StopVectorEnrichmentJobInput {
- /**
- * The Amazon Resource Name (ARN) of the Vector Enrichment job.
- */
- Arn: VectorEnrichmentJobArn;
- }
- export interface StopVectorEnrichmentJobOutput {
- }
- export type String = string;
- export type StringListInput = String[];
- export type SyntheticTimestamp_date_time = Date;
- export type TagKeyList = String[];
- export interface TagResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource you want to tag.
- */
- ResourceArn: Arn;
- /**
- * Each tag consists of a key and a value.
- */
- Tags: Tags;
- }
- export interface TagResourceResponse {
- }
- export type Tags = {[key: string]: String};
- export type TargetOptions = "INPUT"|"OUTPUT"|string;
- export type TemporalStatistics = "MEAN"|"MEDIAN"|"STANDARD_DEVIATION"|string;
- export interface TemporalStatisticsConfigInput {
- /**
- * The input for the temporal statistics grouping by time frequency option.
- */
- GroupBy?: GroupBy;
- /**
- * The list of the statistics method options.
- */
- Statistics: TemporalStatisticsListInput;
- /**
- * The list of target band names for the temporal statistic to calculate.
- */
- TargetBands?: StringListInput;
- }
- export type TemporalStatisticsListInput = TemporalStatistics[];
- export interface TimeRangeFilterInput {
- /**
- * The end time for the time-range filter.
- */
- EndTime: Timestamp;
- /**
- * The start time for the time-range filter.
- */
- StartTime: Timestamp;
- }
- export interface TimeRangeFilterOutput {
- /**
- * The ending time for the time range filter.
- */
- EndTime: SyntheticTimestamp_date_time;
- /**
- * The starting time for the time range filter.
- */
- StartTime: SyntheticTimestamp_date_time;
- }
- export type Timestamp = Date;
- export type Unit = "METERS"|string;
- export interface UntagResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource you want to untag.
- */
- ResourceArn: Arn;
- /**
- * Keys of the tags you want to remove.
- */
- TagKeys: TagKeyList;
- }
- export interface UntagResourceResponse {
- }
- export interface UserDefined {
- /**
- * The units for output resolution of the result.
- */
- Unit: Unit;
- /**
- * The value for output resolution of the result.
- */
- Value: Float;
- }
- export type VectorEnrichmentJobArn = string;
- export interface VectorEnrichmentJobConfig {
- /**
- * The input structure for Map Matching operation type.
- */
- MapMatchingConfig?: MapMatchingConfig;
- /**
- * The input structure for Reverse Geocoding operation type.
- */
- ReverseGeocodingConfig?: ReverseGeocodingConfig;
- }
- export interface VectorEnrichmentJobDataSourceConfigInput {
- /**
- * The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.
- */
- S3Data?: VectorEnrichmentJobS3Data;
- }
- export type VectorEnrichmentJobDocumentType = "CSV"|string;
- export interface VectorEnrichmentJobErrorDetails {
- /**
- * A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.
- */
- ErrorMessage?: String;
- /**
- * The type of error generated during the Vector Enrichment job.
- */
- ErrorType?: VectorEnrichmentJobErrorType;
- }
- export type VectorEnrichmentJobErrorType = "CLIENT_ERROR"|"SERVER_ERROR"|string;
- export interface VectorEnrichmentJobExportErrorDetails {
- /**
- * The message providing details about the errors generated during the Vector Enrichment job.
- */
- Message?: String;
- /**
- * The output error details for an Export operation on a Vector Enrichment job.
- */
- Type?: VectorEnrichmentJobExportErrorType;
- }
- export type VectorEnrichmentJobExportErrorType = "CLIENT_ERROR"|"SERVER_ERROR"|string;
- export type VectorEnrichmentJobExportStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string;
- export interface VectorEnrichmentJobInputConfig {
- /**
- * The input structure for the data source that represents the storage type of the input data objects.
- */
- DataSourceConfig: VectorEnrichmentJobDataSourceConfigInput;
- /**
- * The input structure that defines the data source file type.
- */
- DocumentType: VectorEnrichmentJobDocumentType;
- }
- export type VectorEnrichmentJobList = ListVectorEnrichmentJobOutputConfig[];
- export interface VectorEnrichmentJobS3Data {
- /**
- * The Key Management Service key ID for server-side encryption.
- */
- KmsKeyId?: KmsKey;
- /**
- * The URL to the Amazon S3 data for the Vector Enrichment job.
- */
- S3Uri: S3Uri;
- }
- export type VectorEnrichmentJobStatus = "INITIALIZING"|"IN_PROGRESS"|"STOPPING"|"STOPPED"|"COMPLETED"|"FAILED"|"DELETING"|"DELETED"|string;
- export type VectorEnrichmentJobType = "REVERSE_GEOCODING"|"MAP_MATCHING"|string;
- export interface ViewOffNadirInput {
- /**
- * The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.
- */
- LowerBound: Float;
- /**
- * The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.
- */
- UpperBound: Float;
- }
- export interface ViewSunAzimuthInput {
- /**
- * The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.
- */
- LowerBound: Float;
- /**
- * The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.
- */
- UpperBound: Float;
- }
- export interface ViewSunElevationInput {
- /**
- * The lower bound to view the sun elevation.
- */
- LowerBound: Float;
- /**
- * The upper bound to view the sun elevation.
- */
- UpperBound: Float;
- }
- export type ZonalStatistics = "MEAN"|"MEDIAN"|"STANDARD_DEVIATION"|"MAX"|"MIN"|"SUM"|string;
- export interface ZonalStatisticsConfigInput {
- /**
- * List of zonal statistics to compute.
- */
- Statistics: ZonalStatisticsListInput;
- /**
- * Bands used in the operation. If no target bands are specified, it uses all bands available input.
- */
- TargetBands?: StringListInput;
- /**
- * The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
- */
- ZoneS3Path: S3Uri;
- /**
- * The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>" For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
- */
- ZoneS3PathKmsKeyId?: KmsKey;
- }
- export type ZonalStatisticsListInput = ZonalStatistics[];
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- export type apiVersion = "2020-05-27"|"latest"|string;
- export interface ClientApiVersions {
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- apiVersion?: apiVersion;
- }
- export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
- /**
- * Contains interfaces for use with the SageMakerGeospatial client.
- */
- export import Types = SageMakerGeospatial;
- }
- export = SageMakerGeospatial;
|