AWS SDK for PHP 3.x

Client: Aws\SageMakerGeospatial\SageMakerGeospatialClient

Service ID: sagemaker-geospatial

Version: 2020-05-27

This page describes the parameters and results for the operations of the Amazon SageMaker geospatial capabilities (2020-05-27), and shows how to use the Aws\SageMakerGeospatial\SageMakerGeospatialClient object to call the described operations. This documentation is specific to the 2020-05-27 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DeleteEarthObservationJob ( array $params = [] ): Use this operation to delete an Earth Observation job.
DeleteVectorEnrichmentJob ( array $params = [] ): Use this operation to delete a Vector Enrichment job.
ExportEarthObservationJob ( array $params = [] ): 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.
ExportVectorEnrichmentJob ( array $params = [] ): Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
GetEarthObservationJob ( array $params = [] ): Get the details for a previously initiated Earth Observation job.
GetRasterDataCollection ( array $params = [] ): Use this operation to get details of a specific raster data collection.
GetTile ( array $params = [] ): Gets a web mercator tile for the given Earth Observation job.
GetVectorEnrichmentJob ( array $params = [] ): Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
ListEarthObservationJobs ( array $params = [] ): Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
ListRasterDataCollections ( array $params = [] ): Use this operation to get raster data collections.
ListTagsForResource ( array $params = [] ): Lists the tags attached to the resource.
ListVectorEnrichmentJobs ( array $params = [] ): Retrieves a list of vector enrichment jobs.
SearchRasterDataCollection ( array $params = [] ): Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
StartEarthObservationJob ( array $params = [] ): Use this operation to create an Earth observation job.
StartVectorEnrichmentJob ( array $params = [] ): Creates a Vector Enrichment job for the supplied job type.
StopEarthObservationJob ( array $params = [] ): Use this operation to stop an existing earth observation job.
StopVectorEnrichmentJob ( array $params = [] ): Stops the Vector Enrichment job for a given job ARN.
TagResource ( array $params = [] ): The resource you want to tag.
UntagResource ( array $params = [] ): The resource you want to untag.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListEarthObservationJobs
ListRasterDataCollections
ListVectorEnrichmentJobs
SearchRasterDataCollection

Operations

DeleteEarthObservationJob

$result = $client->deleteEarthObservationJob([/* ... */]);
$promise = $client->deleteEarthObservationJobAsync([/* ... */]);

Use this operation to delete an Earth Observation job.

Parameter Syntax

$result = $client->deleteEarthObservationJob([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Earth Observation job being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

DeleteVectorEnrichmentJob

$result = $client->deleteVectorEnrichmentJob([/* ... */]);
$promise = $client->deleteVectorEnrichmentJobAsync([/* ... */]);

Use this operation to delete a Vector Enrichment job.

Parameter Syntax

$result = $client->deleteVectorEnrichmentJob([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

ExportEarthObservationJob

$result = $client->exportEarthObservationJob([/* ... */]);
$promise = $client->exportEarthObservationJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->exportEarthObservationJob([
    'Arn' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'ExportSourceImages' => true || false,
    'OutputConfig' => [ // REQUIRED
        'S3Data' => [ // REQUIRED
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The input Amazon Resource Name (ARN) of the Earth Observation job being exported.

ClientToken

Type: string

A unique token that guarantees that the call to this API is idempotent.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

ExportSourceImages

Type: boolean

The source images provided to the Earth Observation job being exported.

OutputConfig

Required: Yes
Type: OutputConfigInput structure

An object containing information about the output file.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'ExecutionRoleArn' => '<string>',
    'ExportSourceImages' => true || false,
    'ExportStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'OutputConfig' => [
        'S3Data' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
    ],
]

Result Details

Members

Arn

Required: Yes
Type: string

The output Amazon Resource Name (ARN) of the Earth Observation job being exported.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

ExportSourceImages

Type: boolean

The source images provided to the Earth Observation job being exported.

ExportStatus

Required: Yes
Type: string

The status of the results of the Earth Observation job being exported.

OutputConfig

Required: Yes
Type: OutputConfigInput structure

An object containing information about the output file.

Errors

ServiceQuotaExceededException:
You have exceeded the service quota.
AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

ExportVectorEnrichmentJob

$result = $client->exportVectorEnrichmentJob([/* ... */]);
$promise = $client->exportVectorEnrichmentJobAsync([/* ... */]);

Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.

Parameter Syntax

$result = $client->exportVectorEnrichmentJob([
    'Arn' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'OutputConfig' => [ // REQUIRED
        'S3Data' => [ // REQUIRED
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Vector Enrichment job.

ClientToken

Type: string

A unique token that guarantees that the call to this API is idempotent.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.

OutputConfig

Required: Yes
Type: ExportVectorEnrichmentJobOutputConfig structure

Output location information for exporting Vector Enrichment Job results.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'ExecutionRoleArn' => '<string>',
    'ExportStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'OutputConfig' => [
        'S3Data' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
    ],
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.

ExportStatus

Required: Yes
Type: string

The status of the results the Vector Enrichment job being exported.

OutputConfig

Required: Yes
Type: ExportVectorEnrichmentJobOutputConfig structure

Output location information for exporting Vector Enrichment Job results.

Errors

ServiceQuotaExceededException:
You have exceeded the service quota.
AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

GetEarthObservationJob

$result = $client->getEarthObservationJob([/* ... */]);
$promise = $client->getEarthObservationJobAsync([/* ... */]);

Get the details for a previously initiated Earth Observation job.

Parameter Syntax

$result = $client->getEarthObservationJob([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Earth Observation job.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DurationInSeconds' => <integer>,
    'ErrorDetails' => [
        'Message' => '<string>',
        'Type' => 'CLIENT_ERROR|SERVER_ERROR',
    ],
    'ExecutionRoleArn' => '<string>',
    'ExportErrorDetails' => [
        'ExportResults' => [
            'Message' => '<string>',
            'Type' => 'CLIENT_ERROR|SERVER_ERROR',
        ],
        'ExportSourceImages' => [
            'Message' => '<string>',
            'Type' => 'CLIENT_ERROR|SERVER_ERROR',
        ],
    ],
    'ExportStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'InputConfig' => [
        'PreviousEarthObservationJobArn' => '<string>',
        'RasterDataCollectionQuery' => [
            'AreaOfInterest' => [
                'AreaOfInterestGeometry' => [
                    'MultiPolygonGeometry' => [
                        'Coordinates' => [
                            [
                                [
                                    [<float>, ...],
                                    // ...
                                ],
                                // ...
                            ],
                            // ...
                        ],
                    ],
                    'PolygonGeometry' => [
                        'Coordinates' => [
                            [
                                [<float>, ...],
                                // ...
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'PropertyFilters' => [
                'LogicalOperator' => 'AND',
                'Properties' => [
                    [
                        'Property' => [
                            'EoCloudCover' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'LandsatCloudCoverLand' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'Platform' => [
                                'ComparisonOperator' => 'EQUALS|NOT_EQUALS|STARTS_WITH',
                                'Value' => '<string>',
                            ],
                            'ViewOffNadir' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'ViewSunAzimuth' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'ViewSunElevation' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'RasterDataCollectionArn' => '<string>',
            'RasterDataCollectionName' => '<string>',
            'TimeRangeFilter' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
        ],
    ],
    'JobConfig' => [
        'BandMathConfig' => [
            'CustomIndices' => [
                'Operations' => [
                    [
                        'Equation' => '<string>',
                        'Name' => '<string>',
                        'OutputType' => 'INT32|FLOAT32|INT16|FLOAT64|UINT16',
                    ],
                    // ...
                ],
            ],
            'PredefinedIndices' => ['<string>', ...],
        ],
        'CloudMaskingConfig' => [
        ],
        'CloudRemovalConfig' => [
            'AlgorithmName' => 'INTERPOLATION',
            'InterpolationValue' => '<string>',
            'TargetBands' => ['<string>', ...],
        ],
        'GeoMosaicConfig' => [
            'AlgorithmName' => 'NEAR|BILINEAR|CUBIC|CUBICSPLINE|LANCZOS|AVERAGE|RMS|MODE|MAX|MIN|MED|Q1|Q3|SUM',
            'TargetBands' => ['<string>', ...],
        ],
        'LandCoverSegmentationConfig' => [
        ],
        'ResamplingConfig' => [
            'AlgorithmName' => 'NEAR|BILINEAR|CUBIC|CUBICSPLINE|LANCZOS|AVERAGE|RMS|MODE|MAX|MIN|MED|Q1|Q3|SUM',
            'OutputResolution' => [
                'UserDefined' => [
                    'Unit' => 'METERS',
                    'Value' => <float>,
                ],
            ],
            'TargetBands' => ['<string>', ...],
        ],
        'StackConfig' => [
            'OutputResolution' => [
                'Predefined' => 'HIGHEST|LOWEST|AVERAGE',
                'UserDefined' => [
                    'Unit' => 'METERS',
                    'Value' => <float>,
                ],
            ],
            'TargetBands' => ['<string>', ...],
        ],
        'TemporalStatisticsConfig' => [
            'GroupBy' => 'ALL|YEARLY',
            'Statistics' => ['<string>', ...],
            'TargetBands' => ['<string>', ...],
        ],
        'ZonalStatisticsConfig' => [
            'Statistics' => ['<string>', ...],
            'TargetBands' => ['<string>', ...],
            'ZoneS3Path' => '<string>',
            'ZoneS3PathKmsKeyId' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>',
    'OutputBands' => [
        [
            'BandName' => '<string>',
            'OutputDataType' => 'INT32|FLOAT32|INT16|FLOAT64|UINT16',
        ],
        // ...
    ],
    'Status' => 'INITIALIZING|IN_PROGRESS|STOPPING|COMPLETED|STOPPED|FAILED|DELETING|DELETED',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Earth Observation job.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the initiated Earth Observation job.

DurationInSeconds

Required: Yes
Type: int

The duration of Earth Observation job, in seconds.

ErrorDetails

Type: EarthObservationJobErrorDetails structure

Details about the errors generated during the Earth Observation job.

ExecutionRoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

ExportErrorDetails

Type: ExportErrorDetails structure

Details about the errors generated during ExportEarthObservationJob.

ExportStatus

Type: string

The status of the Earth Observation job.

InputConfig

Required: Yes
Type: InputConfigOutput structure

Input data for the Earth Observation job.

JobConfig

Required: Yes
Type: JobConfigInput structure

An object containing information about the job configuration.

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

Name

Required: Yes
Type: string

The name of the Earth Observation job.

OutputBands

Type: Array of OutputBand structures

Bands available in the output of an operation.

Status

Required: Yes
Type: string

The status of a previously initiated Earth Observation job.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

GetRasterDataCollection

$result = $client->getRasterDataCollection([/* ... */]);
$promise = $client->getRasterDataCollectionAsync([/* ... */]);

Use this operation to get details of a specific raster data collection.

Parameter Syntax

$result = $client->getRasterDataCollection([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the raster data collection.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'DescriptionPageUrl' => '<string>',
    'ImageSourceBands' => ['<string>', ...],
    'Name' => '<string>',
    'SupportedFilters' => [
        [
            'Maximum' => <float>,
            'Minimum' => <float>,
            'Name' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
    'Type' => 'PUBLIC|PREMIUM|USER',
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the raster data collection.

Description

Required: Yes
Type: string

A description of the raster data collection.

DescriptionPageUrl

Required: Yes
Type: string

The URL of the description page.

ImageSourceBands

Required: Yes
Type: Array of strings

The list of image source bands in the raster data collection.

Name

Required: Yes
Type: string

The name of the raster data collection.

SupportedFilters

Required: Yes
Type: Array of Filter structures

The filters supported by the raster data collection.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Type

Required: Yes
Type: string

The raster data collection type.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

GetTile

$result = $client->getTile([/* ... */]);
$promise = $client->getTileAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getTile([
    'Arn' => '<string>', // REQUIRED
    'ExecutionRoleArn' => '<string>',
    'ImageAssets' => ['<string>', ...], // REQUIRED
    'ImageMask' => true || false,
    'OutputDataType' => 'INT32|FLOAT32|INT16|FLOAT64|UINT16',
    'OutputFormat' => '<string>',
    'PropertyFilters' => '<string>',
    'Target' => 'INPUT|OUTPUT', // REQUIRED
    'TimeRangeFilter' => '<string>',
    'x' => <integer>, // REQUIRED
    'y' => <integer>, // REQUIRED
    'z' => <integer>, // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

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

ExecutionRoleArn

Type: string

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

ImageAssets

Required: Yes
Type: Array of strings

The particular assets or bands to tile.

ImageMask

Type: boolean

Determines whether or not to return a valid data mask.

OutputDataType

Type: string

The output data type of the tile operation.

OutputFormat

Type: string

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

PropertyFilters

Type: string

Property filters for the imagery to tile.

Target

Required: Yes
Type: string

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

TimeRangeFilter

Type: string

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

x

Required: Yes
Type: int

The x coordinate of the tile input.

y

Required: Yes
Type: int

The y coordinate of the tile input.

z

Required: Yes
Type: int

The z coordinate of the tile input.

Result Syntax

[
    'BinaryFile' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

BinaryFile

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The output binary file.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

GetVectorEnrichmentJob

$result = $client->getVectorEnrichmentJob([/* ... */]);
$promise = $client->getVectorEnrichmentJobAsync([/* ... */]);

Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->getVectorEnrichmentJob([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Vector Enrichment job.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DurationInSeconds' => <integer>,
    'ErrorDetails' => [
        'ErrorMessage' => '<string>',
        'ErrorType' => 'CLIENT_ERROR|SERVER_ERROR',
    ],
    'ExecutionRoleArn' => '<string>',
    'ExportErrorDetails' => [
        'Message' => '<string>',
        'Type' => 'CLIENT_ERROR|SERVER_ERROR',
    ],
    'ExportStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'InputConfig' => [
        'DataSourceConfig' => [
            'S3Data' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
        ],
        'DocumentType' => 'CSV',
    ],
    'JobConfig' => [
        'MapMatchingConfig' => [
            'IdAttributeName' => '<string>',
            'TimestampAttributeName' => '<string>',
            'XAttributeName' => '<string>',
            'YAttributeName' => '<string>',
        ],
        'ReverseGeocodingConfig' => [
            'XAttributeName' => '<string>',
            'YAttributeName' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>',
    'Status' => 'INITIALIZING|IN_PROGRESS|STOPPING|STOPPED|COMPLETED|FAILED|DELETING|DELETED',
    'Tags' => ['<string>', ...],
    'Type' => 'REVERSE_GEOCODING|MAP_MATCHING',
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Vector Enrichment job.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time.

DurationInSeconds

Required: Yes
Type: int

The duration of the Vector Enrichment job, in seconds.

ErrorDetails

Type: VectorEnrichmentJobErrorDetails structure

Details about the errors generated during the Vector Enrichment job.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

ExportErrorDetails

Type: VectorEnrichmentJobExportErrorDetails structure

Details about the errors generated during the ExportVectorEnrichmentJob.

ExportStatus

Type: string

The export status of the Vector Enrichment job being initiated.

InputConfig

Required: Yes
Type: VectorEnrichmentJobInputConfig structure

Input configuration information for the Vector Enrichment job.

JobConfig

Required: Yes
Type: VectorEnrichmentJobConfig structure

An object containing information about the job configuration.

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

Name

Required: Yes
Type: string

The name of the Vector Enrichment job.

Status

Required: Yes
Type: string

The status of the initiated Vector Enrichment job.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Type

Required: Yes
Type: string

The type of the Vector Enrichment job being initiated.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

ListEarthObservationJobs

$result = $client->listEarthObservationJobs([/* ... */]);
$promise = $client->listEarthObservationJobsAsync([/* ... */]);

Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.

Parameter Syntax

$result = $client->listEarthObservationJobs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => '<string>',
    'SortOrder' => 'ASCENDING|DESCENDING',
    'StatusEquals' => 'INITIALIZING|IN_PROGRESS|STOPPING|COMPLETED|STOPPED|FAILED|DELETING|DELETED',
]);

Parameter Details

Members

MaxResults

Type: int

The total number of items to return.

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

SortBy

Type: string

The parameter by which to sort the results.

SortOrder

Type: string

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

StatusEquals

Type: string

A filter that retrieves only jobs with a specific status.

Result Syntax

[
    'EarthObservationJobSummaries' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'DurationInSeconds' => <integer>,
            'Name' => '<string>',
            'OperationType' => '<string>',
            'Status' => 'INITIALIZING|IN_PROGRESS|STOPPING|COMPLETED|STOPPED|FAILED|DELETING|DELETED',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EarthObservationJobSummaries

Required: Yes
Type: Array of ListEarthObservationJobOutputConfig structures

Contains summary information about the Earth Observation jobs.

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

ListRasterDataCollections

$result = $client->listRasterDataCollections([/* ... */]);
$promise = $client->listRasterDataCollectionsAsync([/* ... */]);

Use this operation to get raster data collections.

Parameter Syntax

$result = $client->listRasterDataCollections([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The total number of items to return.

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'RasterDataCollectionSummaries' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'DescriptionPageUrl' => '<string>',
            'Name' => '<string>',
            'SupportedFilters' => [
                [
                    'Maximum' => <float>,
                    'Minimum' => <float>,
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'Tags' => ['<string>', ...],
            'Type' => 'PUBLIC|PREMIUM|USER',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

RasterDataCollectionSummaries

Required: Yes
Type: Array of RasterDataCollectionMetadata structures

Contains summary information about the raster data collection.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags attached to the resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource you want to tag.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

ListVectorEnrichmentJobs

$result = $client->listVectorEnrichmentJobs([/* ... */]);
$promise = $client->listVectorEnrichmentJobsAsync([/* ... */]);

Retrieves a list of vector enrichment jobs.

Parameter Syntax

$result = $client->listVectorEnrichmentJobs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => '<string>',
    'SortOrder' => 'ASCENDING|DESCENDING',
    'StatusEquals' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return.

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

SortBy

Type: string

The parameter by which to sort the results.

SortOrder

Type: string

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

StatusEquals

Type: string

A filter that retrieves only jobs with a specific status.

Result Syntax

[
    'NextToken' => '<string>',
    'VectorEnrichmentJobSummaries' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'DurationInSeconds' => <integer>,
            'Name' => '<string>',
            'Status' => 'INITIALIZING|IN_PROGRESS|STOPPING|STOPPED|COMPLETED|FAILED|DELETING|DELETED',
            'Tags' => ['<string>', ...],
            'Type' => 'REVERSE_GEOCODING|MAP_MATCHING',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

VectorEnrichmentJobSummaries

Required: Yes
Type: Array of ListVectorEnrichmentJobOutputConfig structures

Contains summary information about the Vector Enrichment jobs.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

SearchRasterDataCollection

$result = $client->searchRasterDataCollection([/* ... */]);
$promise = $client->searchRasterDataCollectionAsync([/* ... */]);

Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.

Parameter Syntax

$result = $client->searchRasterDataCollection([
    'Arn' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'RasterDataCollectionQuery' => [ // REQUIRED
        'AreaOfInterest' => [
            'AreaOfInterestGeometry' => [
                'MultiPolygonGeometry' => [
                    'Coordinates' => [ // REQUIRED
                        [
                            [
                                [<float>, ...],
                                // ...
                            ],
                            // ...
                        ],
                        // ...
                    ],
                ],
                'PolygonGeometry' => [
                    'Coordinates' => [ // REQUIRED
                        [
                            [<float>, ...],
                            // ...
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        'BandFilter' => ['<string>', ...],
        'PropertyFilters' => [
            'LogicalOperator' => 'AND',
            'Properties' => [
                [
                    'Property' => [ // REQUIRED
                        'EoCloudCover' => [
                            'LowerBound' => <float>, // REQUIRED
                            'UpperBound' => <float>, // REQUIRED
                        ],
                        'LandsatCloudCoverLand' => [
                            'LowerBound' => <float>, // REQUIRED
                            'UpperBound' => <float>, // REQUIRED
                        ],
                        'Platform' => [
                            'ComparisonOperator' => 'EQUALS|NOT_EQUALS|STARTS_WITH',
                            'Value' => '<string>', // REQUIRED
                        ],
                        'ViewOffNadir' => [
                            'LowerBound' => <float>, // REQUIRED
                            'UpperBound' => <float>, // REQUIRED
                        ],
                        'ViewSunAzimuth' => [
                            'LowerBound' => <float>, // REQUIRED
                            'UpperBound' => <float>, // REQUIRED
                        ],
                        'ViewSunElevation' => [
                            'LowerBound' => <float>, // REQUIRED
                            'UpperBound' => <float>, // REQUIRED
                        ],
                    ],
                ],
                // ...
            ],
        ],
        'TimeRangeFilter' => [ // REQUIRED
            'EndTime' => <integer || string || DateTime>, // REQUIRED
            'StartTime' => <integer || string || DateTime>, // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the raster data collection.

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

RasterDataCollectionQuery

Required: Yes
Type: RasterDataCollectionQueryWithBandFilterInput structure

RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.

Result Syntax

[
    'ApproximateResultCount' => <integer>,
    'Items' => [
        [
            'Assets' => [
                '<String>' => [
                    'Href' => '<string>',
                ],
                // ...
            ],
            'DateTime' => <DateTime>,
            'Geometry' => [
                'Coordinates' => [
                    [
                        [<float>, ...],
                        // ...
                    ],
                    // ...
                ],
                'Type' => '<string>',
            ],
            'Id' => '<string>',
            'Properties' => [
                'EoCloudCover' => <float>,
                'LandsatCloudCoverLand' => <float>,
                'Platform' => '<string>',
                'ViewOffNadir' => <float>,
                'ViewSunAzimuth' => <float>,
                'ViewSunElevation' => <float>,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ApproximateResultCount

Required: Yes
Type: int

Approximate number of results in the response.

Items

Type: Array of ItemSource structures

List of items matching the Raster DataCollectionQuery.

NextToken

Type: string

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

StartEarthObservationJob

$result = $client->startEarthObservationJob([/* ... */]);
$promise = $client->startEarthObservationJobAsync([/* ... */]);

Use this operation to create an Earth observation job.

Parameter Syntax

$result = $client->startEarthObservationJob([
    'ClientToken' => '<string>',
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'InputConfig' => [ // REQUIRED
        'PreviousEarthObservationJobArn' => '<string>',
        'RasterDataCollectionQuery' => [
            'AreaOfInterest' => [
                'AreaOfInterestGeometry' => [
                    'MultiPolygonGeometry' => [
                        'Coordinates' => [ // REQUIRED
                            [
                                [
                                    [<float>, ...],
                                    // ...
                                ],
                                // ...
                            ],
                            // ...
                        ],
                    ],
                    'PolygonGeometry' => [
                        'Coordinates' => [ // REQUIRED
                            [
                                [<float>, ...],
                                // ...
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'PropertyFilters' => [
                'LogicalOperator' => 'AND',
                'Properties' => [
                    [
                        'Property' => [ // REQUIRED
                            'EoCloudCover' => [
                                'LowerBound' => <float>, // REQUIRED
                                'UpperBound' => <float>, // REQUIRED
                            ],
                            'LandsatCloudCoverLand' => [
                                'LowerBound' => <float>, // REQUIRED
                                'UpperBound' => <float>, // REQUIRED
                            ],
                            'Platform' => [
                                'ComparisonOperator' => 'EQUALS|NOT_EQUALS|STARTS_WITH',
                                'Value' => '<string>', // REQUIRED
                            ],
                            'ViewOffNadir' => [
                                'LowerBound' => <float>, // REQUIRED
                                'UpperBound' => <float>, // REQUIRED
                            ],
                            'ViewSunAzimuth' => [
                                'LowerBound' => <float>, // REQUIRED
                                'UpperBound' => <float>, // REQUIRED
                            ],
                            'ViewSunElevation' => [
                                'LowerBound' => <float>, // REQUIRED
                                'UpperBound' => <float>, // REQUIRED
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'RasterDataCollectionArn' => '<string>', // REQUIRED
            'TimeRangeFilter' => [ // REQUIRED
                'EndTime' => <integer || string || DateTime>, // REQUIRED
                'StartTime' => <integer || string || DateTime>, // REQUIRED
            ],
        ],
    ],
    'JobConfig' => [ // REQUIRED
        'BandMathConfig' => [
            'CustomIndices' => [
                'Operations' => [
                    [
                        'Equation' => '<string>', // REQUIRED
                        'Name' => '<string>', // REQUIRED
                        'OutputType' => 'INT32|FLOAT32|INT16|FLOAT64|UINT16',
                    ],
                    // ...
                ],
            ],
            'PredefinedIndices' => ['<string>', ...],
        ],
        'CloudMaskingConfig' => [
        ],
        'CloudRemovalConfig' => [
            'AlgorithmName' => 'INTERPOLATION',
            'InterpolationValue' => '<string>',
            'TargetBands' => ['<string>', ...],
        ],
        'GeoMosaicConfig' => [
            'AlgorithmName' => 'NEAR|BILINEAR|CUBIC|CUBICSPLINE|LANCZOS|AVERAGE|RMS|MODE|MAX|MIN|MED|Q1|Q3|SUM',
            'TargetBands' => ['<string>', ...],
        ],
        'LandCoverSegmentationConfig' => [
        ],
        'ResamplingConfig' => [
            'AlgorithmName' => 'NEAR|BILINEAR|CUBIC|CUBICSPLINE|LANCZOS|AVERAGE|RMS|MODE|MAX|MIN|MED|Q1|Q3|SUM',
            'OutputResolution' => [ // REQUIRED
                'UserDefined' => [ // REQUIRED
                    'Unit' => 'METERS', // REQUIRED
                    'Value' => <float>, // REQUIRED
                ],
            ],
            'TargetBands' => ['<string>', ...],
        ],
        'StackConfig' => [
            'OutputResolution' => [
                'Predefined' => 'HIGHEST|LOWEST|AVERAGE',
                'UserDefined' => [
                    'Unit' => 'METERS', // REQUIRED
                    'Value' => <float>, // REQUIRED
                ],
            ],
            'TargetBands' => ['<string>', ...],
        ],
        'TemporalStatisticsConfig' => [
            'GroupBy' => 'ALL|YEARLY',
            'Statistics' => ['<string>', ...], // REQUIRED
            'TargetBands' => ['<string>', ...],
        ],
        'ZonalStatisticsConfig' => [
            'Statistics' => ['<string>', ...], // REQUIRED
            'TargetBands' => ['<string>', ...],
            'ZoneS3Path' => '<string>', // REQUIRED
            'ZoneS3PathKmsKeyId' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ClientToken

Type: string

A unique token that guarantees that the call to this API is idempotent.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

InputConfig

Required: Yes
Type: InputConfigInput structure

Input configuration information for the Earth Observation job.

JobConfig

Required: Yes
Type: JobConfigInput structure

An object containing information about the job configuration.

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

Name

Required: Yes
Type: string

The name of the Earth Observation job.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DurationInSeconds' => <integer>,
    'ExecutionRoleArn' => '<string>',
    'InputConfig' => [
        'PreviousEarthObservationJobArn' => '<string>',
        'RasterDataCollectionQuery' => [
            'AreaOfInterest' => [
                'AreaOfInterestGeometry' => [
                    'MultiPolygonGeometry' => [
                        'Coordinates' => [
                            [
                                [
                                    [<float>, ...],
                                    // ...
                                ],
                                // ...
                            ],
                            // ...
                        ],
                    ],
                    'PolygonGeometry' => [
                        'Coordinates' => [
                            [
                                [<float>, ...],
                                // ...
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'PropertyFilters' => [
                'LogicalOperator' => 'AND',
                'Properties' => [
                    [
                        'Property' => [
                            'EoCloudCover' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'LandsatCloudCoverLand' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'Platform' => [
                                'ComparisonOperator' => 'EQUALS|NOT_EQUALS|STARTS_WITH',
                                'Value' => '<string>',
                            ],
                            'ViewOffNadir' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'ViewSunAzimuth' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                            'ViewSunElevation' => [
                                'LowerBound' => <float>,
                                'UpperBound' => <float>,
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'RasterDataCollectionArn' => '<string>',
            'RasterDataCollectionName' => '<string>',
            'TimeRangeFilter' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
        ],
    ],
    'JobConfig' => [
        'BandMathConfig' => [
            'CustomIndices' => [
                'Operations' => [
                    [
                        'Equation' => '<string>',
                        'Name' => '<string>',
                        'OutputType' => 'INT32|FLOAT32|INT16|FLOAT64|UINT16',
                    ],
                    // ...
                ],
            ],
            'PredefinedIndices' => ['<string>', ...],
        ],
        'CloudMaskingConfig' => [
        ],
        'CloudRemovalConfig' => [
            'AlgorithmName' => 'INTERPOLATION',
            'InterpolationValue' => '<string>',
            'TargetBands' => ['<string>', ...],
        ],
        'GeoMosaicConfig' => [
            'AlgorithmName' => 'NEAR|BILINEAR|CUBIC|CUBICSPLINE|LANCZOS|AVERAGE|RMS|MODE|MAX|MIN|MED|Q1|Q3|SUM',
            'TargetBands' => ['<string>', ...],
        ],
        'LandCoverSegmentationConfig' => [
        ],
        'ResamplingConfig' => [
            'AlgorithmName' => 'NEAR|BILINEAR|CUBIC|CUBICSPLINE|LANCZOS|AVERAGE|RMS|MODE|MAX|MIN|MED|Q1|Q3|SUM',
            'OutputResolution' => [
                'UserDefined' => [
                    'Unit' => 'METERS',
                    'Value' => <float>,
                ],
            ],
            'TargetBands' => ['<string>', ...],
        ],
        'StackConfig' => [
            'OutputResolution' => [
                'Predefined' => 'HIGHEST|LOWEST|AVERAGE',
                'UserDefined' => [
                    'Unit' => 'METERS',
                    'Value' => <float>,
                ],
            ],
            'TargetBands' => ['<string>', ...],
        ],
        'TemporalStatisticsConfig' => [
            'GroupBy' => 'ALL|YEARLY',
            'Statistics' => ['<string>', ...],
            'TargetBands' => ['<string>', ...],
        ],
        'ZonalStatisticsConfig' => [
            'Statistics' => ['<string>', ...],
            'TargetBands' => ['<string>', ...],
            'ZoneS3Path' => '<string>',
            'ZoneS3PathKmsKeyId' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>',
    'Status' => 'INITIALIZING|IN_PROGRESS|STOPPING|COMPLETED|STOPPED|FAILED|DELETING|DELETED',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Earth Observation job.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time.

DurationInSeconds

Required: Yes
Type: int

The duration of the session, in seconds.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

InputConfig

Type: InputConfigOutput structure

Input configuration information for the Earth Observation job.

JobConfig

Required: Yes
Type: JobConfigInput structure

An object containing information about the job configuration.

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

Name

Required: Yes
Type: string

The name of the Earth Observation job.

Status

Required: Yes
Type: string

The status of the Earth Observation job.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Errors

ServiceQuotaExceededException:
You have exceeded the service quota.
AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

StartVectorEnrichmentJob

$result = $client->startVectorEnrichmentJob([/* ... */]);
$promise = $client->startVectorEnrichmentJobAsync([/* ... */]);

Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.

Parameter Syntax

$result = $client->startVectorEnrichmentJob([
    'ClientToken' => '<string>',
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'InputConfig' => [ // REQUIRED
        'DataSourceConfig' => [ // REQUIRED
            'S3Data' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>', // REQUIRED
            ],
        ],
        'DocumentType' => 'CSV', // REQUIRED
    ],
    'JobConfig' => [ // REQUIRED
        'MapMatchingConfig' => [
            'IdAttributeName' => '<string>', // REQUIRED
            'TimestampAttributeName' => '<string>', // REQUIRED
            'XAttributeName' => '<string>', // REQUIRED
            'YAttributeName' => '<string>', // REQUIRED
        ],
        'ReverseGeocodingConfig' => [
            'XAttributeName' => '<string>', // REQUIRED
            'YAttributeName' => '<string>', // REQUIRED
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ClientToken

Type: string

A unique token that guarantees that the call to this API is idempotent.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

InputConfig

Required: Yes
Type: VectorEnrichmentJobInputConfig structure

Input configuration information for the Vector Enrichment job.

JobConfig

Required: Yes
Type: VectorEnrichmentJobConfig structure

An object containing information about the job configuration.

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

Name

Required: Yes
Type: string

The name of the Vector Enrichment job.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DurationInSeconds' => <integer>,
    'ExecutionRoleArn' => '<string>',
    'InputConfig' => [
        'DataSourceConfig' => [
            'S3Data' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
        ],
        'DocumentType' => 'CSV',
    ],
    'JobConfig' => [
        'MapMatchingConfig' => [
            'IdAttributeName' => '<string>',
            'TimestampAttributeName' => '<string>',
            'XAttributeName' => '<string>',
            'YAttributeName' => '<string>',
        ],
        'ReverseGeocodingConfig' => [
            'XAttributeName' => '<string>',
            'YAttributeName' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>',
    'Status' => 'INITIALIZING|IN_PROGRESS|STOPPING|STOPPED|COMPLETED|FAILED|DELETING|DELETED',
    'Tags' => ['<string>', ...],
    'Type' => 'REVERSE_GEOCODING|MAP_MATCHING',
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Vector Enrichment job.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time.

DurationInSeconds

Required: Yes
Type: int

The duration of the Vector Enrichment job, in seconds.

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

InputConfig

Required: Yes
Type: VectorEnrichmentJobInputConfig structure

Input configuration information for starting the Vector Enrichment job.

JobConfig

Required: Yes
Type: VectorEnrichmentJobConfig structure

An object containing information about the job configuration.

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

Name

Required: Yes
Type: string

The name of the Vector Enrichment job.

Status

Required: Yes
Type: string

The status of the Vector Enrichment job being started.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Type

Required: Yes
Type: string

The type of the Vector Enrichment job.

Errors

ServiceQuotaExceededException:
You have exceeded the service quota.
AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

StopEarthObservationJob

$result = $client->stopEarthObservationJob([/* ... */]);
$promise = $client->stopEarthObservationJobAsync([/* ... */]);

Use this operation to stop an existing earth observation job.

Parameter Syntax

$result = $client->stopEarthObservationJob([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Earth Observation job being stopped.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

StopVectorEnrichmentJob

$result = $client->stopVectorEnrichmentJob([/* ... */]);
$promise = $client->stopVectorEnrichmentJobAsync([/* ... */]);

Stops the Vector Enrichment job for a given job ARN.

Parameter Syntax

$result = $client->stopVectorEnrichmentJob([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Vector Enrichment job.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.
ConflictException:
Updating or deleting a resource can cause an inconsistent state.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

The resource you want to tag.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource you want to tag.

Tags

Required: Yes
Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

The resource you want to untag.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource you want to untag.

TagKeys

Required: Yes
Type: Array of strings

Keys of the tags you want to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException:
The request references a resource which does not exist.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

Message

Required: Yes
Type: string

AreaOfInterest

Description

The geographic extent of the Earth Observation job.

Members

AreaOfInterestGeometry

Type: AreaOfInterestGeometry structure

A GeoJSON object representing the geographic extent in the coordinate space.

AreaOfInterestGeometry

Description

A GeoJSON object representing the geographic extent in the coordinate space.

Members

MultiPolygonGeometry

Type: MultiPolygonGeometryInput structure

The structure representing the MultiPolygon Geometry.

PolygonGeometry

Type: PolygonGeometryInput structure

The structure representing Polygon Geometry.

AssetValue

Description

The structure containing the asset properties.

Members

Href

Type: string

Link to the asset object.

BandMathConfigInput

Description

Input structure for the BandMath operation type. Defines Predefined and CustomIndices to be computed using BandMath.

Members

CustomIndices

Type: CustomIndicesInput structure

CustomIndices that are computed.

PredefinedIndices

Type: Array of strings

One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.

CloudMaskingConfigInput

Description

Input structure for CloudMasking operation type.

Members

CloudRemovalConfigInput

Description

Input structure for Cloud Removal Operation type

Members

AlgorithmName

Type: string

The name of the algorithm used for cloud removal.

InterpolationValue

Type: string

The interpolation value you provide for cloud removal.

TargetBands

Type: Array of strings

TargetBands to be returned in the output of CloudRemoval operation.

ConflictException

Description

Updating or deleting a resource can cause an inconsistent state.

Members

Message

Required: Yes
Type: string

ResourceId

Type: string

Identifier of the resource affected.

CustomIndicesInput

Description

Input object defining the custom BandMath indices to compute.

Members

Operations

Type: Array of Operation structures

A list of BandMath indices to compute.

EarthObservationJobErrorDetails

Description

The structure representing the errors in an EarthObservationJob.

Members

Message

Type: string

A detailed message describing the error in an Earth Observation job.

Type

Type: string

The type of error in an Earth Observation job.

EoCloudCoverInput

Description

The structure representing the EoCloudCover filter.

Members

LowerBound

Required: Yes
Type: float

Lower bound for EoCloudCover.

UpperBound

Required: Yes
Type: float

Upper bound for EoCloudCover.

ExportErrorDetails

Description

The structure for returning the export error details in a GetEarthObservationJob.

Members

ExportResults

Type: ExportErrorDetailsOutput structure

The structure for returning the export error details while exporting results of an Earth Observation job.

ExportSourceImages

Type: ExportErrorDetailsOutput structure

The structure for returning the export error details while exporting the source images of an Earth Observation job.

ExportErrorDetailsOutput

Description

The structure representing the errors in an export EarthObservationJob operation.

Members

Message

Type: string

A detailed message describing the error in an export EarthObservationJob operation.

Type

Type: string

The type of error in an export EarthObservationJob operation.

ExportS3DataInput

Description

The structure containing the Amazon S3 path to export the Earth Observation job output.

Members

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

S3Uri

Required: Yes
Type: string

The URL to the Amazon S3 data input.

ExportVectorEnrichmentJobOutputConfig

Description

An object containing information about the output file.

Members

S3Data

Required: Yes
Type: VectorEnrichmentJobS3Data structure

The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.

Filter

Description

The structure representing the filters supported by a RasterDataCollection.

Members

Maximum

Type: float

The maximum value of the filter.

Minimum

Type: float

The minimum value of the filter.

Name

Required: Yes
Type: string

The name of the filter.

Type

Required: Yes
Type: string

The type of the filter being used.

GeoMosaicConfigInput

Description

Input configuration information for the geomosaic.

Members

AlgorithmName

Type: string

The name of the algorithm being used for geomosaic.

TargetBands

Type: Array of strings

The target bands for geomosaic.

Geometry

Description

The structure representing a Geometry in terms of Type and Coordinates as per GeoJson spec.

Members

Coordinates

Required: Yes
Type: Array of lists

The coordinates of the GeoJson Geometry.

Type

Required: Yes
Type: string

GeoJson Geometry types like Polygon and MultiPolygon.

InputConfigInput

Description

Input configuration information.

Members

PreviousEarthObservationJobArn

Type: string

The Amazon Resource Name (ARN) of the previous Earth Observation job.

RasterDataCollectionQuery

Type: RasterDataCollectionQueryInput structure

The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters.

InputConfigOutput

Description

The InputConfig for an EarthObservationJob response.

Members

PreviousEarthObservationJobArn

Type: string

The Amazon Resource Name (ARN) of the previous Earth Observation job.

RasterDataCollectionQuery

Type: RasterDataCollectionQueryOutput structure

The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.

InternalServerException

Description

The request processing has failed because of an unknown error, exception, or failure.

Members

Message

Required: Yes
Type: string

ResourceId

Type: string

ItemSource

Description

The structure representing the items in the response for SearchRasterDataCollection.

Members

Assets

Type: Associative array of custom strings keys (String) to AssetValue structures

This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.

DateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The searchable date and time of the item, in UTC.

Geometry

Required: Yes
Type: Geometry structure

The item Geometry in GeoJson format.

Id

Required: Yes
Type: string

A unique Id for the source item.

Properties

Type: Properties structure

This field contains additional properties of the item.

JobConfigInput

Description

The input structure for the JobConfig in an EarthObservationJob.

Members

BandMathConfig

Type: BandMathConfigInput structure

An object containing information about the job configuration for BandMath.

CloudMaskingConfig

Type: CloudMaskingConfigInput structure

An object containing information about the job configuration for cloud masking.

CloudRemovalConfig

Type: CloudRemovalConfigInput structure

An object containing information about the job configuration for cloud removal.

GeoMosaicConfig

Type: GeoMosaicConfigInput structure

An object containing information about the job configuration for geomosaic.

LandCoverSegmentationConfig

Type: LandCoverSegmentationConfigInput structure

An object containing information about the job configuration for land cover segmentation.

ResamplingConfig

Type: ResamplingConfigInput structure

An object containing information about the job configuration for resampling.

StackConfig

Type: StackConfigInput structure

An object containing information about the job configuration for a Stacking Earth Observation job.

TemporalStatisticsConfig

Type: TemporalStatisticsConfigInput structure

An object containing information about the job configuration for temporal statistics.

ZonalStatisticsConfig

Type: ZonalStatisticsConfigInput structure

An object containing information about the job configuration for zonal statistics.

LandCoverSegmentationConfigInput

Description

The input structure for Land Cover Operation type.

Members

LandsatCloudCoverLandInput

Description

The structure representing Land Cloud Cover property for Landsat data collection.

Members

LowerBound

Required: Yes
Type: float

The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.

UpperBound

Required: Yes
Type: 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.

ListEarthObservationJobOutputConfig

Description

An object containing information about the output file.

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time.

DurationInSeconds

Required: Yes
Type: int

The duration of the session, in seconds.

Name

Required: Yes
Type: string

The names of the Earth Observation jobs in the list.

OperationType

Required: Yes
Type: string

The operation type for an Earth Observation job.

Status

Required: Yes
Type: string

The status of the list of the Earth Observation jobs.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

ListVectorEnrichmentJobOutputConfig

Description

An object containing information about the output file.

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time.

DurationInSeconds

Required: Yes
Type: int

The duration of the session, in seconds.

Name

Required: Yes
Type: string

The names of the Vector Enrichment jobs in the list.

Status

Required: Yes
Type: string

The status of the Vector Enrichment jobs list.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Type

Required: Yes
Type: string

The type of the list of Vector Enrichment jobs.

MapMatchingConfig

Description

The input structure for Map Matching operation type.

Members

IdAttributeName

Required: Yes
Type: string

The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.

TimestampAttributeName

Required: Yes
Type: string

The name of the timestamp attribute.

XAttributeName

Required: Yes
Type: string

The name of the X-attribute

YAttributeName

Required: Yes
Type: string

The name of the Y-attribute

MultiPolygonGeometryInput

Description

The structure representing Polygon Geometry based on the GeoJson spec.

Members

Coordinates

Required: Yes
Type: Array of lists

The coordinates of the multipolygon geometry.

Operation

Description

Represents an arithmetic operation to compute spectral index.

Members

Equation

Required: Yes
Type: string

Textual representation of the math operation; Equation used to compute the spectral index.

Name

Required: Yes
Type: string

The name of the operation.

OutputType

Type: string

The type of the operation.

OutputBand

Description

A single EarthObservationJob output band.

Members

BandName

Required: Yes
Type: string

The name of the band.

OutputDataType

Required: Yes
Type: string

The datatype of the output band.

OutputConfigInput

Description

The response structure for an OutputConfig returned by an ExportEarthObservationJob.

Members

S3Data

Required: Yes
Type: ExportS3DataInput structure

Path to Amazon S3 storage location for the output configuration file.

OutputResolutionResamplingInput

Description

OutputResolution Configuration indicating the target resolution for the output of Resampling operation.

Members

UserDefined

Required: Yes
Type: UserDefined structure

User Defined Resolution for the output of Resampling operation defined by value and unit.

OutputResolutionStackInput

Description

The input structure representing Output Resolution for Stacking Operation.

Members

Predefined

Type: string

A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.

UserDefined

Type: UserDefined structure

The structure representing User Output Resolution for a Stacking operation defined as a value and unit.

PlatformInput

Description

The input structure for specifying Platform. 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.

Members

ComparisonOperator

Type: string

The ComparisonOperator to use with PlatformInput.

Value

Required: Yes
Type: string

The value of the platform.

PolygonGeometryInput

Description

The structure representing Polygon Geometry based on the GeoJson spec.

Members

Coordinates

Required: Yes
Type: Array of lists

Coordinates representing a Polygon based on the GeoJson spec.

Properties

Description

Properties associated with the Item.

Members

EoCloudCover

Type: float

Estimate of cloud cover.

LandsatCloudCoverLand

Type: float

Land cloud cover for Landsat Data Collection.

Platform

Type: string

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.

ViewOffNadir

Type: float

The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).

ViewSunAzimuth

Type: 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).

ViewSunElevation

Type: 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.

Property

Description

Represents a single searchable property to search on.

Members

EoCloudCover

Type: EoCloudCoverInput structure

The structure representing EoCloudCover property filter containing a lower bound and upper bound.

LandsatCloudCoverLand

Type: LandsatCloudCoverLandInput structure

The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.

Platform

Type: PlatformInput structure

The structure representing Platform property filter consisting of value and comparison operator.

ViewOffNadir

Type: ViewOffNadirInput structure

The structure representing ViewOffNadir property filter containing a lower bound and upper bound.

ViewSunAzimuth

Type: ViewSunAzimuthInput structure

The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.

ViewSunElevation

Type: ViewSunElevationInput structure

The structure representing ViewSunElevation property filter containing a lower bound and upper bound.

PropertyFilter

Description

The structure representing a single PropertyFilter.

Members

Property

Required: Yes
Type: Property structure

Represents a single property to match with when searching a raster data collection.

PropertyFilters

Description

A list of PropertyFilter objects.

Members

LogicalOperator

Type: string

The Logical Operator used to combine the Property Filters.

Properties

Type: Array of PropertyFilter structures

A list of Property Filters.

RasterDataCollectionMetadata

Description

Response object containing details for a specific RasterDataCollection.

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the raster data collection.

Description

Required: Yes
Type: string

A description of the raster data collection.

DescriptionPageUrl

Type: string

The description URL of the raster data collection.

Name

Required: Yes
Type: string

The name of the raster data collection.

SupportedFilters

Required: Yes
Type: Array of Filter structures

The list of filters supported by the raster data collection.

Tags

Type: Associative array of custom strings keys (String) to strings

Each tag consists of a key and a value.

Type

Required: Yes
Type: string

The type of raster data collection.

RasterDataCollectionQueryInput

Description

The input structure for Raster Data Collection Query containing the Area of Interest, TimeRange Filters, and Property Filters.

Members

AreaOfInterest

Type: AreaOfInterest structure

The area of interest being queried for the raster data collection.

PropertyFilters

Type: PropertyFilters structure

The list of Property filters used in the Raster Data Collection Query.

RasterDataCollectionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the raster data collection.

TimeRangeFilter

Required: Yes
Type: TimeRangeFilterInput structure

The TimeRange Filter used in the RasterDataCollection Query.

RasterDataCollectionQueryOutput

Description

The output structure contains the Raster Data Collection Query input along with some additional metadata.

Members

AreaOfInterest

Type: AreaOfInterest structure

The Area of Interest used in the search.

PropertyFilters

Type: PropertyFilters structure

Property filters used in the search.

RasterDataCollectionArn

Required: Yes
Type: string

The ARN of the Raster Data Collection against which the search is done.

RasterDataCollectionName

Required: Yes
Type: string

The name of the raster data collection.

TimeRangeFilter

Required: Yes
Type: TimeRangeFilterOutput structure

The TimeRange filter used in the search.

RasterDataCollectionQueryWithBandFilterInput

Description

This is a RasterDataCollectionQueryInput containing AreaOfInterest, Time Range filter and Property filters.

Members

AreaOfInterest

Type: AreaOfInterest structure

The Area of interest to be used in the search query.

BandFilter

Type: Array of strings

The list of Bands to be displayed in the result for each item.

PropertyFilters

Type: PropertyFilters structure

The Property Filters used in the search query.

TimeRangeFilter

Required: Yes
Type: TimeRangeFilterInput structure

The TimeRange Filter used in the search query.

ResamplingConfigInput

Description

The structure representing input for resampling operation.

Members

AlgorithmName

Type: string

The name of the algorithm used for resampling.

OutputResolution

Required: Yes
Type: OutputResolutionResamplingInput structure

The structure representing output resolution (in target georeferenced units) of the result of resampling operation.

TargetBands

Type: Array of strings

Bands used in the operation. If no target bands are specified, it uses all bands available in the input.

ResourceNotFoundException

Description

The request references a resource which does not exist.

Members

Message

Required: Yes
Type: string

ResourceId

Type: string

Identifier of the resource that was not found.

ReverseGeocodingConfig

Description

The input structure for Reverse Geocoding operation type.

Members

XAttributeName

Required: Yes
Type: string

The field name for the data that describes x-axis coordinate, eg. longitude of a point.

YAttributeName

Required: Yes
Type: string

The field name for the data that describes y-axis coordinate, eg. latitude of a point.

ServiceQuotaExceededException

Description

You have exceeded the service quota.

Members

Message

Required: Yes
Type: string

ResourceId

Type: string

Identifier of the resource affected.

StackConfigInput

Description

The input structure for Stacking Operation.

Members

OutputResolution

Type: OutputResolutionStackInput structure

The structure representing output resolution (in target georeferenced units) of the result of stacking operation.

TargetBands

Type: Array of strings

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.

TemporalStatisticsConfigInput

Description

The structure representing the configuration for Temporal Statistics operation.

Members

GroupBy

Type: string

The input for the temporal statistics grouping by time frequency option.

Statistics

Required: Yes
Type: Array of strings

The list of the statistics method options.

TargetBands

Type: Array of strings

The list of target band names for the temporal statistic to calculate.

ThrottlingException

Description

The request was denied due to request throttling.

Members

Message

Required: Yes
Type: string

ResourceId

Type: string

TimeRangeFilterInput

Description

The input for the time-range filter.

Members

EndTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time for the time-range filter.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time for the time-range filter.

TimeRangeFilterOutput

Description

The output structure of the time range filter.

Members

EndTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The ending time for the time range filter.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The starting time for the time range filter.

UserDefined

Description

The output resolution (in target georeferenced units) of the result of the operation

Members

Unit

Required: Yes
Type: string

The units for output resolution of the result.

Value

Required: Yes
Type: float

The value for output resolution of the result.

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members

Message

Required: Yes
Type: string

ResourceId

Type: string

VectorEnrichmentJobConfig

Description

It contains configs such as ReverseGeocodingConfig and MapMatchingConfig.

Members

MapMatchingConfig

Type: MapMatchingConfig structure

The input structure for Map Matching operation type.

ReverseGeocodingConfig

Type: ReverseGeocodingConfig structure

The input structure for Reverse Geocoding operation type.

VectorEnrichmentJobDataSourceConfigInput

Description

The input structure for the data source that represents the storage type of the input data objects.

Members

S3Data

Type: VectorEnrichmentJobS3Data structure

The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.

VectorEnrichmentJobErrorDetails

Description

VectorEnrichmentJob error details in response from GetVectorEnrichmentJob.

Members

ErrorMessage

Type: string

A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.

ErrorType

Type: string

The type of error generated during the Vector Enrichment job.

VectorEnrichmentJobExportErrorDetails

Description

VectorEnrichmentJob export error details in response from GetVectorEnrichmentJob.

Members

Message

Type: string

The message providing details about the errors generated during the Vector Enrichment job.

Type

Type: string

The output error details for an Export operation on a Vector Enrichment job.

VectorEnrichmentJobInputConfig

Description

The input structure for the InputConfig in a VectorEnrichmentJob.

Members

DataSourceConfig

Required: Yes
Type: VectorEnrichmentJobDataSourceConfigInput structure

The input structure for the data source that represents the storage type of the input data objects.

DocumentType

Required: Yes
Type: string

The input structure that defines the data source file type.

VectorEnrichmentJobS3Data

Description

The Amazon S3 data for the Vector Enrichment job.

Members

KmsKeyId

Type: string

The Key Management Service key ID for server-side encryption.

S3Uri

Required: Yes
Type: string

The URL to the Amazon S3 data for the Vector Enrichment job.

ViewOffNadirInput

Description

The input structure for specifying ViewOffNadir property filter. ViewOffNadir refers to the angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).

Members

LowerBound

Required: Yes
Type: float

The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.

UpperBound

Required: Yes
Type: float

The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.

ViewSunAzimuthInput

Description

The input structure for specifying ViewSunAzimuth property filter. ViewSunAzimuth refers to 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).

Members

LowerBound

Required: Yes
Type: float

The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.

UpperBound

Required: Yes
Type: float

The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.

ViewSunElevationInput

Description

The input structure for specifying ViewSunElevation angle property filter.

Members

LowerBound

Required: Yes
Type: float

The lower bound to view the sun elevation.

UpperBound

Required: Yes
Type: float

The upper bound to view the sun elevation.

ZonalStatisticsConfigInput

Description

The structure representing input configuration of ZonalStatistics operation.

Members

Statistics

Required: Yes
Type: Array of strings

List of zonal statistics to compute.

TargetBands

Type: Array of strings

Bands used in the operation. If no target bands are specified, it uses all bands available input.

ZoneS3Path

Required: Yes
Type: string

The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.

ZoneS3PathKmsKeyId

Type: string

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.

Amazon SageMaker geospatial capabilities 2020-05-27

Operation Summary

Paginators

Operations

DeleteEarthObservationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteVectorEnrichmentJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

ExportEarthObservationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ExportVectorEnrichmentJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetEarthObservationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetRasterDataCollection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetTile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetVectorEnrichmentJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListEarthObservationJobs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRasterDataCollections

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details