sagemakergeospatial

package module
v1.14.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 45 Imported by: 6

Documentation

Overview

Package sagemakergeospatial provides the API client, operations, and parameter types for Amazon SageMaker geospatial capabilities.

Provides APIs for creating and managing SageMaker geospatial resources.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-05-27"
View Source 
const ServiceID = "SageMaker Geospatial"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.4.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.7.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.7.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.7.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.7.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon SageMaker geospatial capabilities.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) DeleteEarthObservationJob 

func (c *Client) DeleteEarthObservationJob(ctx context.Context, params *DeleteEarthObservationJobInput, optFns ...func(*Options)) (*DeleteEarthObservationJobOutput, error)

Use this operation to delete an Earth Observation job.

func (*Client) DeleteVectorEnrichmentJob 

func (c *Client) DeleteVectorEnrichmentJob(ctx context.Context, params *DeleteVectorEnrichmentJobInput, optFns ...func(*Options)) (*DeleteVectorEnrichmentJobOutput, error)

Use this operation to delete a Vector Enrichment job.

func (*Client) ExportEarthObservationJob 

func (c *Client) ExportEarthObservationJob(ctx context.Context, params *ExportEarthObservationJobInput, optFns ...func(*Options)) (*ExportEarthObservationJobOutput, error)

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.

func (*Client) ExportVectorEnrichmentJob 

func (c *Client) ExportVectorEnrichmentJob(ctx context.Context, params *ExportVectorEnrichmentJobInput, optFns ...func(*Options)) (*ExportVectorEnrichmentJobOutput, error)

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

func (*Client) GetEarthObservationJob 

func (c *Client) GetEarthObservationJob(ctx context.Context, params *GetEarthObservationJobInput, optFns ...func(*Options)) (*GetEarthObservationJobOutput, error)

Get the details for a previously initiated Earth Observation job.

func (*Client) GetRasterDataCollection 

func (c *Client) GetRasterDataCollection(ctx context.Context, params *GetRasterDataCollectionInput, optFns ...func(*Options)) (*GetRasterDataCollectionOutput, error)

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

func (*Client) GetTile 

func (c *Client) GetTile(ctx context.Context, params *GetTileInput, optFns ...func(*Options)) (*GetTileOutput, error)

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

func (*Client) GetVectorEnrichmentJob 

func (c *Client) GetVectorEnrichmentJob(ctx context.Context, params *GetVectorEnrichmentJobInput, optFns ...func(*Options)) (*GetVectorEnrichmentJobOutput, error)

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

func (*Client) ListEarthObservationJobs 

func (c *Client) ListEarthObservationJobs(ctx context.Context, params *ListEarthObservationJobsInput, optFns ...func(*Options)) (*ListEarthObservationJobsOutput, error)

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

func (*Client) ListRasterDataCollections 

func (c *Client) ListRasterDataCollections(ctx context.Context, params *ListRasterDataCollectionsInput, optFns ...func(*Options)) (*ListRasterDataCollectionsOutput, error)

Use this operation to get raster data collections.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags attached to the resource.

func (*Client) ListVectorEnrichmentJobs 

func (c *Client) ListVectorEnrichmentJobs(ctx context.Context, params *ListVectorEnrichmentJobsInput, optFns ...func(*Options)) (*ListVectorEnrichmentJobsOutput, error)

Retrieves a list of vector enrichment jobs.

func (*Client) Options added in v1.8.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) SearchRasterDataCollection 

func (c *Client) SearchRasterDataCollection(ctx context.Context, params *SearchRasterDataCollectionInput, optFns ...func(*Options)) (*SearchRasterDataCollectionOutput, error)

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

func (*Client) StartEarthObservationJob 

func (c *Client) StartEarthObservationJob(ctx context.Context, params *StartEarthObservationJobInput, optFns ...func(*Options)) (*StartEarthObservationJobOutput, error)

Use this operation to create an Earth observation job.

func (*Client) StartVectorEnrichmentJob 

func (c *Client) StartVectorEnrichmentJob(ctx context.Context, params *StartVectorEnrichmentJobInput, optFns ...func(*Options)) (*StartVectorEnrichmentJobOutput, error)

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

func (*Client) StopEarthObservationJob 

func (c *Client) StopEarthObservationJob(ctx context.Context, params *StopEarthObservationJobInput, optFns ...func(*Options)) (*StopEarthObservationJobOutput, error)

Use this operation to stop an existing earth observation job.

func (*Client) StopVectorEnrichmentJob 

func (c *Client) StopVectorEnrichmentJob(ctx context.Context, params *StopVectorEnrichmentJobInput, optFns ...func(*Options)) (*StopVectorEnrichmentJobOutput, error)

Stops the Vector Enrichment job for a given job ARN.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

The resource you want to tag.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

The resource you want to untag.

type DeleteEarthObservationJobInput 

type DeleteEarthObservationJobInput struct {

	// The Amazon Resource Name (ARN) of the Earth Observation job being deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteEarthObservationJobOutput 

type DeleteEarthObservationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVectorEnrichmentJobInput 

type DeleteVectorEnrichmentJobInput struct {

	// The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteVectorEnrichmentJobOutput 

type DeleteVectorEnrichmentJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.4.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.4.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.4.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.4.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.4.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExportEarthObservationJobInput 

type ExportEarthObservationJobInput struct {

	// The input Amazon Resource Name (ARN) of the Earth Observation job being
	// exported.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
	//
	// This member is required.
	ExecutionRoleArn *string

	// An object containing information about the output file.
	//
	// This member is required.
	OutputConfig *types.OutputConfigInput

	// A unique token that guarantees that the call to this API is idempotent.
	ClientToken *string

	// The source images provided to the Earth Observation job being exported.
	ExportSourceImages *bool
	// contains filtered or unexported fields
}

type ExportEarthObservationJobOutput 

type ExportEarthObservationJobOutput struct {

	// The output Amazon Resource Name (ARN) of the Earth Observation job being
	// exported.
	//
	// This member is required.
	Arn *string

	// The creation time.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
	//
	// This member is required.
	ExecutionRoleArn *string

	// The status of the results of the Earth Observation job being exported.
	//
	// This member is required.
	ExportStatus types.EarthObservationJobExportStatus

	// An object containing information about the output file.
	//
	// This member is required.
	OutputConfig *types.OutputConfigInput

	// The source images provided to the Earth Observation job being exported.
	ExportSourceImages *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ExportVectorEnrichmentJobInput 

type ExportVectorEnrichmentJobInput struct {

	// The Amazon Resource Name (ARN) of the Vector Enrichment job.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the
	// location in OutputConfig.
	//
	// This member is required.
	ExecutionRoleArn *string

	// Output location information for exporting Vector Enrichment Job results.
	//
	// This member is required.
	OutputConfig *types.ExportVectorEnrichmentJobOutputConfig

	// A unique token that guarantees that the call to this API is idempotent.
	ClientToken *string
	// contains filtered or unexported fields
}

type ExportVectorEnrichmentJobOutput 

type ExportVectorEnrichmentJobOutput struct {

	// The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
	//
	// This member is required.
	Arn *string

	// The creation time.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the IAM role with permission to upload to the
	// location in OutputConfig.
	//
	// This member is required.
	ExecutionRoleArn *string

	// The status of the results the Vector Enrichment job being exported.
	//
	// This member is required.
	ExportStatus types.VectorEnrichmentJobExportStatus

	// Output location information for exporting Vector Enrichment Job results.
	//
	// This member is required.
	OutputConfig *types.ExportVectorEnrichmentJobOutputConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEarthObservationJobInput 

type GetEarthObservationJobInput struct {

	// The Amazon Resource Name (ARN) of the Earth Observation job.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetEarthObservationJobOutput 

type GetEarthObservationJobOutput struct {

	// The Amazon Resource Name (ARN) of the Earth Observation job.
	//
	// This member is required.
	Arn *string

	// The creation time of the initiated Earth Observation job.
	//
	// This member is required.
	CreationTime *time.Time

	// The duration of Earth Observation job, in seconds.
	//
	// This member is required.
	DurationInSeconds *int32

	// Input data for the Earth Observation job.
	//
	// This member is required.
	InputConfig *types.InputConfigOutput

	// An object containing information about the job configuration.
	//
	// This member is required.
	JobConfig types.JobConfigInput

	// The name of the Earth Observation job.
	//
	// This member is required.
	Name *string

	// The status of a previously initiated Earth Observation job.
	//
	// This member is required.
	Status types.EarthObservationJobStatus

	// Details about the errors generated during the Earth Observation job.
	ErrorDetails *types.EarthObservationJobErrorDetails

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

	// Details about the errors generated during ExportEarthObservationJob.
	ExportErrorDetails *types.ExportErrorDetails

	// The status of the Earth Observation job.
	ExportStatus types.EarthObservationJobExportStatus

	// The Key Management Service key ID for server-side encryption.
	KmsKeyId *string

	// Bands available in the output of an operation.
	OutputBands []types.OutputBand

	// Each tag consists of a key and a value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRasterDataCollectionInput 

type GetRasterDataCollectionInput struct {

	// The Amazon Resource Name (ARN) of the raster data collection.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetRasterDataCollectionOutput 

type GetRasterDataCollectionOutput struct {

	// The Amazon Resource Name (ARN) of the raster data collection.
	//
	// This member is required.
	Arn *string

	// A description of the raster data collection.
	//
	// This member is required.
	Description *string

	// The URL of the description page.
	//
	// This member is required.
	DescriptionPageUrl *string

	// The list of image source bands in the raster data collection.
	//
	// This member is required.
	ImageSourceBands []string

	// The name of the raster data collection.
	//
	// This member is required.
	Name *string

	// The filters supported by the raster data collection.
	//
	// This member is required.
	SupportedFilters []types.Filter

	// The raster data collection type.
	//
	// This member is required.
	Type types.DataCollectionType

	// Each tag consists of a key and a value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTileInput 

type GetTileInput struct {

	// The Amazon Resource Name (ARN) of the tile operation.
	//
	// This member is required.
	Arn *string

	// The particular assets or bands to tile.
	//
	// This member is required.
	ImageAssets []string

	// Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT'
	// are the valid options.
	//
	// This member is required.
	Target types.TargetOptions

	// The x coordinate of the tile input.
	//
	// This member is required.
	X *int32

	// The y coordinate of the tile input.
	//
	// This member is required.
	Y *int32

	// The z coordinate of the tile input.
	//
	// This member is required.
	Z *int32

	// The Amazon Resource Name (ARN) of the IAM role that you specify.
	ExecutionRoleArn *string

	// Determines whether or not to return a valid data mask.
	ImageMask *bool

	// The output data type of the tile operation.
	OutputDataType types.OutputType

	// The data format of the output tile. The formats include .npy, .png and .jpg.
	OutputFormat *string

	// Property filters for the imagery to tile.
	PropertyFilters *string

	// Time range filter applied to imagery to find the images to tile.
	TimeRangeFilter *string
	// contains filtered or unexported fields
}

type GetTileOutput 

type GetTileOutput struct {

	// The output binary file.
	//
	// This value conforms to the media type: application/x-binary
	BinaryFile io.ReadCloser

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVectorEnrichmentJobInput 

type GetVectorEnrichmentJobInput struct {

	// The Amazon Resource Name (ARN) of the Vector Enrichment job.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetVectorEnrichmentJobOutput 

type GetVectorEnrichmentJobOutput struct {

	// The Amazon Resource Name (ARN) of the Vector Enrichment job.
	//
	// This member is required.
	Arn *string

	// The creation time.
	//
	// This member is required.
	CreationTime *time.Time

	// The duration of the Vector Enrichment job, in seconds.
	//
	// This member is required.
	DurationInSeconds *int32

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
	//
	// This member is required.
	ExecutionRoleArn *string

	// Input configuration information for the Vector Enrichment job.
	//
	// This member is required.
	InputConfig *types.VectorEnrichmentJobInputConfig

	// An object containing information about the job configuration.
	//
	// This member is required.
	JobConfig types.VectorEnrichmentJobConfig

	// The name of the Vector Enrichment job.
	//
	// This member is required.
	Name *string

	// The status of the initiated Vector Enrichment job.
	//
	// This member is required.
	Status types.VectorEnrichmentJobStatus

	// The type of the Vector Enrichment job being initiated.
	//
	// This member is required.
	Type types.VectorEnrichmentJobType

	// Details about the errors generated during the Vector Enrichment job.
	ErrorDetails *types.VectorEnrichmentJobErrorDetails

	// Details about the errors generated during the ExportVectorEnrichmentJob.
	ExportErrorDetails *types.VectorEnrichmentJobExportErrorDetails

	// The export status of the Vector Enrichment job being initiated.
	ExportStatus types.VectorEnrichmentJobExportStatus

	// The Key Management Service key ID for server-side encryption.
	KmsKeyId *string

	// Each tag consists of a key and a value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListEarthObservationJobsAPIClient 

type ListEarthObservationJobsAPIClient interface {
	ListEarthObservationJobs(context.Context, *ListEarthObservationJobsInput, ...func(*Options)) (*ListEarthObservationJobsOutput, error)
}

ListEarthObservationJobsAPIClient is a client that implements the ListEarthObservationJobs operation.

type ListEarthObservationJobsInput 

type ListEarthObservationJobsInput struct {

	// The total number of items to return.
	MaxResults *int32

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

	// The parameter by which to sort the results.
	SortBy *string

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

	// A filter that retrieves only jobs with a specific status.
	StatusEquals types.EarthObservationJobStatus
	// contains filtered or unexported fields
}

type ListEarthObservationJobsOutput 

type ListEarthObservationJobsOutput struct {

	// Contains summary information about the Earth Observation jobs.
	//
	// This member is required.
	EarthObservationJobSummaries []types.ListEarthObservationJobOutputConfig

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEarthObservationJobsPaginator 

type ListEarthObservationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListEarthObservationJobsPaginator is a paginator for ListEarthObservationJobs

func NewListEarthObservationJobsPaginator 

func NewListEarthObservationJobsPaginator(client ListEarthObservationJobsAPIClient, params *ListEarthObservationJobsInput, optFns ...func(*ListEarthObservationJobsPaginatorOptions)) *ListEarthObservationJobsPaginator

NewListEarthObservationJobsPaginator returns a new ListEarthObservationJobsPaginator

func (*ListEarthObservationJobsPaginator) HasMorePages 

func (p *ListEarthObservationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEarthObservationJobsPaginator) NextPage 

func (p *ListEarthObservationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEarthObservationJobsOutput, error)

NextPage retrieves the next ListEarthObservationJobs page.

type ListEarthObservationJobsPaginatorOptions 

type ListEarthObservationJobsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEarthObservationJobsPaginatorOptions is the paginator options for ListEarthObservationJobs

type ListRasterDataCollectionsAPIClient 

type ListRasterDataCollectionsAPIClient interface {
	ListRasterDataCollections(context.Context, *ListRasterDataCollectionsInput, ...func(*Options)) (*ListRasterDataCollectionsOutput, error)
}

ListRasterDataCollectionsAPIClient is a client that implements the ListRasterDataCollections operation.

type ListRasterDataCollectionsInput 

type ListRasterDataCollectionsInput struct {

	// The total number of items to return.
	MaxResults *int32

	// If the previous response was truncated, you receive this token. Use it in your
	// next request to receive the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRasterDataCollectionsOutput 

type ListRasterDataCollectionsOutput struct {

	// Contains summary information about the raster data collection.
	//
	// This member is required.
	RasterDataCollectionSummaries []types.RasterDataCollectionMetadata

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRasterDataCollectionsPaginator 

type ListRasterDataCollectionsPaginator struct {
	// contains filtered or unexported fields
}

ListRasterDataCollectionsPaginator is a paginator for ListRasterDataCollections

func NewListRasterDataCollectionsPaginator 

func NewListRasterDataCollectionsPaginator(client ListRasterDataCollectionsAPIClient, params *ListRasterDataCollectionsInput, optFns ...func(*ListRasterDataCollectionsPaginatorOptions)) *ListRasterDataCollectionsPaginator

NewListRasterDataCollectionsPaginator returns a new ListRasterDataCollectionsPaginator

func (*ListRasterDataCollectionsPaginator) HasMorePages 

func (p *ListRasterDataCollectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRasterDataCollectionsPaginator) NextPage 

func (p *ListRasterDataCollectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRasterDataCollectionsOutput, error)

NextPage retrieves the next ListRasterDataCollections page.

type ListRasterDataCollectionsPaginatorOptions 

type ListRasterDataCollectionsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRasterDataCollectionsPaginatorOptions is the paginator options for ListRasterDataCollections

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource you want to tag.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Each tag consists of a key and a value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVectorEnrichmentJobsAPIClient 

type ListVectorEnrichmentJobsAPIClient interface {
	ListVectorEnrichmentJobs(context.Context, *ListVectorEnrichmentJobsInput, ...func(*Options)) (*ListVectorEnrichmentJobsOutput, error)
}

ListVectorEnrichmentJobsAPIClient is a client that implements the ListVectorEnrichmentJobs operation.

type ListVectorEnrichmentJobsInput 

type ListVectorEnrichmentJobsInput struct {

	// The maximum number of items to return.
	MaxResults *int32

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

	// The parameter by which to sort the results.
	SortBy *string

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

	// A filter that retrieves only jobs with a specific status.
	StatusEquals *string
	// contains filtered or unexported fields
}

type ListVectorEnrichmentJobsOutput 

type ListVectorEnrichmentJobsOutput struct {

	// Contains summary information about the Vector Enrichment jobs.
	//
	// This member is required.
	VectorEnrichmentJobSummaries []types.ListVectorEnrichmentJobOutputConfig

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVectorEnrichmentJobsPaginator 

type ListVectorEnrichmentJobsPaginator struct {
	// contains filtered or unexported fields
}

ListVectorEnrichmentJobsPaginator is a paginator for ListVectorEnrichmentJobs

func NewListVectorEnrichmentJobsPaginator 

func NewListVectorEnrichmentJobsPaginator(client ListVectorEnrichmentJobsAPIClient, params *ListVectorEnrichmentJobsInput, optFns ...func(*ListVectorEnrichmentJobsPaginatorOptions)) *ListVectorEnrichmentJobsPaginator

NewListVectorEnrichmentJobsPaginator returns a new ListVectorEnrichmentJobsPaginator

func (*ListVectorEnrichmentJobsPaginator) HasMorePages 

func (p *ListVectorEnrichmentJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVectorEnrichmentJobsPaginator) NextPage 

func (p *ListVectorEnrichmentJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVectorEnrichmentJobsOutput, error)

NextPage retrieves the next ListVectorEnrichmentJobs page.

type ListVectorEnrichmentJobsPaginatorOptions 

type ListVectorEnrichmentJobsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVectorEnrichmentJobsPaginatorOptions is the paginator options for ListVectorEnrichmentJobs

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.7.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchRasterDataCollectionAPIClient 

type SearchRasterDataCollectionAPIClient interface {
	SearchRasterDataCollection(context.Context, *SearchRasterDataCollectionInput, ...func(*Options)) (*SearchRasterDataCollectionOutput, error)
}

SearchRasterDataCollectionAPIClient is a client that implements the SearchRasterDataCollection operation.

type SearchRasterDataCollectionInput 

type SearchRasterDataCollectionInput struct {

	// The Amazon Resource Name (ARN) of the raster data collection.
	//
	// This member is required.
	Arn *string

	// RasterDataCollectionQuery consisting of [AreaOfInterest(AOI)], [PropertyFilters] and [TimeRangeFilterInput] used in [SearchRasterDataCollection].
	//
	// [PropertyFilters]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_PropertyFilter.html
	// [TimeRangeFilterInput]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_TimeRangeFilterInput.html
	// [AreaOfInterest(AOI)]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_AreaOfInterest.html
	// [SearchRasterDataCollection]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_SearchRasterDataCollection.html
	//
	// This member is required.
	RasterDataCollectionQuery *types.RasterDataCollectionQueryWithBandFilterInput

	// If the previous response was truncated, you receive this token. Use it in your
	// next request to receive the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchRasterDataCollectionOutput 

type SearchRasterDataCollectionOutput struct {

	// Approximate number of results in the response.
	//
	// This member is required.
	ApproximateResultCount *int32

	// List of items matching the Raster DataCollectionQuery.
	Items []types.ItemSource

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchRasterDataCollectionPaginator 

type SearchRasterDataCollectionPaginator struct {
	// contains filtered or unexported fields
}

SearchRasterDataCollectionPaginator is a paginator for SearchRasterDataCollection

func NewSearchRasterDataCollectionPaginator 

func NewSearchRasterDataCollectionPaginator(client SearchRasterDataCollectionAPIClient, params *SearchRasterDataCollectionInput, optFns ...func(*SearchRasterDataCollectionPaginatorOptions)) *SearchRasterDataCollectionPaginator

NewSearchRasterDataCollectionPaginator returns a new SearchRasterDataCollectionPaginator

func (*SearchRasterDataCollectionPaginator) HasMorePages 

func (p *SearchRasterDataCollectionPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchRasterDataCollectionPaginator) NextPage 

func (p *SearchRasterDataCollectionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchRasterDataCollectionOutput, error)

NextPage retrieves the next SearchRasterDataCollection page.

type SearchRasterDataCollectionPaginatorOptions 

type SearchRasterDataCollectionPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchRasterDataCollectionPaginatorOptions is the paginator options for SearchRasterDataCollection

type StartEarthObservationJobInput 

type StartEarthObservationJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
	//
	// This member is required.
	ExecutionRoleArn *string

	// Input configuration information for the Earth Observation job.
	//
	// This member is required.
	InputConfig *types.InputConfigInput

	// An object containing information about the job configuration.
	//
	// This member is required.
	JobConfig types.JobConfigInput

	// The name of the Earth Observation job.
	//
	// This member is required.
	Name *string

	// A unique token that guarantees that the call to this API is idempotent.
	ClientToken *string

	// The Key Management Service key ID for server-side encryption.
	KmsKeyId *string

	// Each tag consists of a key and a value.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartEarthObservationJobOutput 

type StartEarthObservationJobOutput struct {

	// The Amazon Resource Name (ARN) of the Earth Observation job.
	//
	// This member is required.
	Arn *string

	// The creation time.
	//
	// This member is required.
	CreationTime *time.Time

	// The duration of the session, in seconds.
	//
	// This member is required.
	DurationInSeconds *int32

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
	//
	// This member is required.
	ExecutionRoleArn *string

	// An object containing information about the job configuration.
	//
	// This member is required.
	JobConfig types.JobConfigInput

	// The name of the Earth Observation job.
	//
	// This member is required.
	Name *string

	// The status of the Earth Observation job.
	//
	// This member is required.
	Status types.EarthObservationJobStatus

	// Input configuration information for the Earth Observation job.
	InputConfig *types.InputConfigOutput

	// The Key Management Service key ID for server-side encryption.
	KmsKeyId *string

	// Each tag consists of a key and a value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartVectorEnrichmentJobInput 

type StartVectorEnrichmentJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
	//
	// This member is required.
	ExecutionRoleArn *string

	// Input configuration information for the Vector Enrichment job.
	//
	// This member is required.
	InputConfig *types.VectorEnrichmentJobInputConfig

	// An object containing information about the job configuration.
	//
	// This member is required.
	JobConfig types.VectorEnrichmentJobConfig

	// The name of the Vector Enrichment job.
	//
	// This member is required.
	Name *string

	// A unique token that guarantees that the call to this API is idempotent.
	ClientToken *string

	// The Key Management Service key ID for server-side encryption.
	KmsKeyId *string

	// Each tag consists of a key and a value.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartVectorEnrichmentJobOutput 

type StartVectorEnrichmentJobOutput struct {

	// The Amazon Resource Name (ARN) of the Vector Enrichment job.
	//
	// This member is required.
	Arn *string

	// The creation time.
	//
	// This member is required.
	CreationTime *time.Time

	// The duration of the Vector Enrichment job, in seconds.
	//
	// This member is required.
	DurationInSeconds *int32

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
	//
	// This member is required.
	ExecutionRoleArn *string

	// Input configuration information for starting the Vector Enrichment job.
	//
	// This member is required.
	InputConfig *types.VectorEnrichmentJobInputConfig

	// An object containing information about the job configuration.
	//
	// This member is required.
	JobConfig types.VectorEnrichmentJobConfig

	// The name of the Vector Enrichment job.
	//
	// This member is required.
	Name *string

	// The status of the Vector Enrichment job being started.
	//
	// This member is required.
	Status types.VectorEnrichmentJobStatus

	// The type of the Vector Enrichment job.
	//
	// This member is required.
	Type types.VectorEnrichmentJobType

	// The Key Management Service key ID for server-side encryption.
	KmsKeyId *string

	// Each tag consists of a key and a value.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopEarthObservationJobInput 

type StopEarthObservationJobInput struct {

	// The Amazon Resource Name (ARN) of the Earth Observation job being stopped.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type StopEarthObservationJobOutput 

type StopEarthObservationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopVectorEnrichmentJobInput 

type StopVectorEnrichmentJobInput struct {

	// The Amazon Resource Name (ARN) of the Vector Enrichment job.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type StopVectorEnrichmentJobOutput 

type StopVectorEnrichmentJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource you want to tag.
	//
	// This member is required.
	ResourceArn *string

	// Each tag consists of a key and a value.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource you want to untag.
	//
	// This member is required.
	ResourceArn *string

	// Keys of the tags you want to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.