AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the SageMaker Geospatial StartEarthObservationJob API operation.

Syntax

Start-SMGSEarthObservationJob
-Name <String>
-CloudRemovalConfig_AlgorithmName <AlgorithmNameCloudRemoval>
-GeoMosaicConfig_AlgorithmName <AlgorithmNameGeoMosaic>
-ResamplingConfig_AlgorithmName <AlgorithmNameResampling>
-JobConfig_CloudMaskingConfig <CloudMaskingConfigInput>
-MultiPolygonGeometry_Coordinate <Double[][][][]>
-PolygonGeometry_Coordinate <Double[][][]>
-TimeRangeFilter_EndTime <DateTime>
-ExecutionRoleArn <String>
-TemporalStatisticsConfig_GroupBy <GroupBy>
-CloudRemovalConfig_InterpolationValue <String>
-KmsKeyId <String>
-JobConfig_LandCoverSegmentationConfig <LandCoverSegmentationConfigInput>
-PropertyFilters_LogicalOperator <LogicalOperator>
-CustomIndices_Operation <Operation[]>
-OutputResolution_Predefined <PredefinedResolution>
-BandMathConfig_PredefinedIndex <String[]>
-InputConfig_PreviousEarthObservationJobArn <String>
-PropertyFilters_Property <PropertyFilter[]>
-RasterDataCollectionQuery_RasterDataCollectionArn <String>
-TimeRangeFilter_StartTime <DateTime>
-TemporalStatisticsConfig_Statistic <String[]>
-ZonalStatisticsConfig_Statistic <String[]>
-Tag <Hashtable>
-CloudRemovalConfig_TargetBand <String[]>
-GeoMosaicConfig_TargetBand <String[]>
-ResamplingConfig_TargetBand <String[]>
-StackConfig_TargetBand <String[]>
-TemporalStatisticsConfig_TargetBand <String[]>
-ZonalStatisticsConfig_TargetBand <String[]>
-JobConfig_ResamplingConfig_OutputResolution_UserDefined_Unit <Unit>
-JobConfig_StackConfig_OutputResolution_UserDefined_Unit <Unit>
-JobConfig_ResamplingConfig_OutputResolution_UserDefined_Value <Single>
-JobConfig_StackConfig_OutputResolution_UserDefined_Value <Single>
-ZonalStatisticsConfig_ZoneS3Path <String>
-ZonalStatisticsConfig_ZoneS3PathKmsKeyId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerGeospatialConfig>

Description

Use this operation to create an Earth observation job.

Parameters

-BandMathConfig_PredefinedIndex <String[]>
One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_BandMathConfig_PredefinedIndices
-ClientConfig <AmazonSageMakerGeospatialConfig>
Amazon.PowerShell.Cmdlets.SMGS.AmazonSageMakerGeospatialClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique token that guarantees that the call to this API is idempotent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudRemovalConfig_AlgorithmName <AlgorithmNameCloudRemoval>
The name of the algorithm used for cloud removal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_CloudRemovalConfig_AlgorithmName
-CloudRemovalConfig_InterpolationValue <String>
The interpolation value you provide for cloud removal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_CloudRemovalConfig_InterpolationValue
-CloudRemovalConfig_TargetBand <String[]>
TargetBands to be returned in the output of CloudRemoval operation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_CloudRemovalConfig_TargetBands
-CustomIndices_Operation <Operation[]>
A list of BandMath indices to compute. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_BandMathConfig_CustomIndices_Operations
-ExecutionRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GeoMosaicConfig_AlgorithmName <AlgorithmNameGeoMosaic>
The name of the algorithm being used for geomosaic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_GeoMosaicConfig_AlgorithmName
-GeoMosaicConfig_TargetBand <String[]>
The target bands for geomosaic. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_GeoMosaicConfig_TargetBands
-InputConfig_PreviousEarthObservationJobArn <String>
The Amazon Resource Name (ARN) of the previous Earth Observation job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfig_CloudMaskingConfig <CloudMaskingConfigInput>
An object containing information about the job configuration for cloud masking.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfig_LandCoverSegmentationConfig <LandCoverSegmentationConfigInput>
An object containing information about the job configuration for land cover segmentation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfig_ResamplingConfig_OutputResolution_UserDefined_Unit <Unit>
The units for output resolution of the result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfig_ResamplingConfig_OutputResolution_UserDefined_Value <Single>
The value for output resolution of the result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfig_StackConfig_OutputResolution_UserDefined_Unit <Unit>
The units for output resolution of the result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfig_StackConfig_OutputResolution_UserDefined_Value <Single>
The value for output resolution of the result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
The Key Management Service key ID for server-side encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MultiPolygonGeometry_Coordinate <Double[][][][]>
The coordinates of the multipolygon geometry. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_RasterDataCollectionQuery_AreaOfInterest_AreaOfInterestGeometry_MultiPolygonGeometry_Coordinates
-Name <String>
The name of the Earth Observation job.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OutputResolution_Predefined <PredefinedResolution>
A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_StackConfig_OutputResolution_Predefined
-PolygonGeometry_Coordinate <Double[][][]>
Coordinates representing a Polygon based on the GeoJson spec. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_RasterDataCollectionQuery_AreaOfInterest_AreaOfInterestGeometry_PolygonGeometry_Coordinates
-PropertyFilters_LogicalOperator <LogicalOperator>
The Logical Operator used to combine the Property Filters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_RasterDataCollectionQuery_PropertyFilters_LogicalOperator
-PropertyFilters_Property <PropertyFilter[]>
A list of Property Filters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_RasterDataCollectionQuery_PropertyFilters_Properties
-RasterDataCollectionQuery_RasterDataCollectionArn <String>
The Amazon Resource Name (ARN) of the raster data collection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_RasterDataCollectionQuery_RasterDataCollectionArn
-ResamplingConfig_AlgorithmName <AlgorithmNameResampling>
The name of the algorithm used for resampling.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_ResamplingConfig_AlgorithmName
-ResamplingConfig_TargetBand <String[]>
Bands used in the operation. If no target bands are specified, it uses all bands available in the input. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_ResamplingConfig_TargetBands
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMakerGeospatial.Model.StartEarthObservationJobResponse). Specifying the name of a property of type Amazon.SageMakerGeospatial.Model.StartEarthObservationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StackConfig_TargetBand <String[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_StackConfig_TargetBands
-Tag <Hashtable>
Each tag consists of a key and a value. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TemporalStatisticsConfig_GroupBy <GroupBy>
The input for the temporal statistics grouping by time frequency option.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_TemporalStatisticsConfig_GroupBy
-TemporalStatisticsConfig_Statistic <String[]>
The list of the statistics method options. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_TemporalStatisticsConfig_Statistics
-TemporalStatisticsConfig_TargetBand <String[]>
The list of target band names for the temporal statistic to calculate. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_TemporalStatisticsConfig_TargetBands
-TimeRangeFilter_EndTime <DateTime>
The end time for the time-range filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_RasterDataCollectionQuery_TimeRangeFilter_EndTime
-TimeRangeFilter_StartTime <DateTime>
The start time for the time-range filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_RasterDataCollectionQuery_TimeRangeFilter_StartTime
-ZonalStatisticsConfig_Statistic <String[]>
List of zonal statistics to compute. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_ZonalStatisticsConfig_Statistics
-ZonalStatisticsConfig_TargetBand <String[]>
Bands used in the operation. If no target bands are specified, it uses all bands available input. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_ZonalStatisticsConfig_TargetBands
-ZonalStatisticsConfig_ZoneS3Path <String>
The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_ZonalStatisticsConfig_ZoneS3Path
-ZonalStatisticsConfig_ZoneS3PathKmsKeyId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfig_ZonalStatisticsConfig_ZoneS3PathKmsKeyId

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.SageMakerGeospatial.Model.StartEarthObservationJobResponse
This cmdlet returns an Amazon.SageMakerGeospatial.Model.StartEarthObservationJobResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z