groundstation

package module
v1.27.0 Latest Latest
Warning

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

 Go to latest Published: Apr 3, 2024 License: Apache-2.0 Imports: 41 Imported by: 3

Documentation

Overview

Package groundstation provides the API client, operations, and parameter types for AWS Ground Station.

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.

Index

Constants

View Source 
const ServiceAPIVersion = "2019-05-23"
View Source 
const ServiceID = "GroundStation"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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.19.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.22.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.22.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.22.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.22.2 

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

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

type CancelContactInput 

type CancelContactInput struct {

	// UUID of a contact.
	//
	// This member is required.
	ContactId *string
	// contains filtered or unexported fields
}

type CancelContactOutput 

type CancelContactOutput struct {

	// UUID of a contact.
	ContactId *string

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

type Client 

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

Client provides the API client to make operations call for AWS Ground Station.

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) CancelContact 

func (c *Client) CancelContact(ctx context.Context, params *CancelContactInput, optFns ...func(*Options)) (*CancelContactOutput, error)

Cancels a contact with a specified contact ID.

func (*Client) CreateConfig 

func (c *Client) CreateConfig(ctx context.Context, params *CreateConfigInput, optFns ...func(*Options)) (*CreateConfigOutput, error)

Creates a Config with the specified configData parameters. Only one type of configData can be specified.

func (*Client) CreateDataflowEndpointGroup 

func (c *Client) CreateDataflowEndpointGroup(ctx context.Context, params *CreateDataflowEndpointGroupInput, optFns ...func(*Options)) (*CreateDataflowEndpointGroupOutput, error)

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects. The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact. When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

func (*Client) CreateEphemeris added in v1.14.0 

func (c *Client) CreateEphemeris(ctx context.Context, params *CreateEphemerisInput, optFns ...func(*Options)) (*CreateEphemerisOutput, error)

Creates an Ephemeris with the specified EphemerisData .

func (*Client) CreateMissionProfile 

func (c *Client) CreateMissionProfile(ctx context.Context, params *CreateMissionProfileInput, optFns ...func(*Options)) (*CreateMissionProfileOutput, error)

Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.

func (*Client) DeleteConfig 

func (c *Client) DeleteConfig(ctx context.Context, params *DeleteConfigInput, optFns ...func(*Options)) (*DeleteConfigOutput, error)

Deletes a Config .

func (*Client) DeleteDataflowEndpointGroup 

func (c *Client) DeleteDataflowEndpointGroup(ctx context.Context, params *DeleteDataflowEndpointGroupInput, optFns ...func(*Options)) (*DeleteDataflowEndpointGroupOutput, error)

Deletes a dataflow endpoint group.

func (*Client) DeleteEphemeris added in v1.14.0 

func (c *Client) DeleteEphemeris(ctx context.Context, params *DeleteEphemerisInput, optFns ...func(*Options)) (*DeleteEphemerisOutput, error)

Deletes an ephemeris

func (*Client) DeleteMissionProfile 

func (c *Client) DeleteMissionProfile(ctx context.Context, params *DeleteMissionProfileInput, optFns ...func(*Options)) (*DeleteMissionProfileOutput, error)

Deletes a mission profile.

func (*Client) DescribeContact 

func (c *Client) DescribeContact(ctx context.Context, params *DescribeContactInput, optFns ...func(*Options)) (*DescribeContactOutput, error)

Describes an existing contact.

func (*Client) DescribeEphemeris added in v1.14.0 

func (c *Client) DescribeEphemeris(ctx context.Context, params *DescribeEphemerisInput, optFns ...func(*Options)) (*DescribeEphemerisOutput, error)

Describes an existing ephemeris.

func (*Client) GetAgentConfiguration added in v1.17.0 

func (c *Client) GetAgentConfiguration(ctx context.Context, params *GetAgentConfigurationInput, optFns ...func(*Options)) (*GetAgentConfigurationOutput, error)

For use by AWS Ground Station Agent and shouldn't be called directly. Gets the latest configuration information for a registered agent.

func (*Client) GetConfig 

func (c *Client) GetConfig(ctx context.Context, params *GetConfigInput, optFns ...func(*Options)) (*GetConfigOutput, error)

Returns Config information. Only one Config response can be returned.

func (*Client) GetDataflowEndpointGroup 

func (c *Client) GetDataflowEndpointGroup(ctx context.Context, params *GetDataflowEndpointGroupInput, optFns ...func(*Options)) (*GetDataflowEndpointGroupOutput, error)

Returns the dataflow endpoint group.

func (*Client) GetMinuteUsage 

func (c *Client) GetMinuteUsage(ctx context.Context, params *GetMinuteUsageInput, optFns ...func(*Options)) (*GetMinuteUsageOutput, error)

Returns the number of reserved minutes used by account.

func (*Client) GetMissionProfile 

func (c *Client) GetMissionProfile(ctx context.Context, params *GetMissionProfileInput, optFns ...func(*Options)) (*GetMissionProfileOutput, error)

Returns a mission profile.

func (*Client) GetSatellite 

func (c *Client) GetSatellite(ctx context.Context, params *GetSatelliteInput, optFns ...func(*Options)) (*GetSatelliteOutput, error)

Returns a satellite.

func (*Client) ListConfigs 

func (c *Client) ListConfigs(ctx context.Context, params *ListConfigsInput, optFns ...func(*Options)) (*ListConfigsOutput, error)

Returns a list of Config objects.

func (*Client) ListContacts 

func (c *Client) ListContacts(ctx context.Context, params *ListContactsInput, optFns ...func(*Options)) (*ListContactsOutput, error)

Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation , missionprofileArn , and satelliteArn .

func (*Client) ListDataflowEndpointGroups 

func (c *Client) ListDataflowEndpointGroups(ctx context.Context, params *ListDataflowEndpointGroupsInput, optFns ...func(*Options)) (*ListDataflowEndpointGroupsOutput, error)

Returns a list of DataflowEndpoint groups.

func (*Client) ListEphemerides added in v1.14.0 

func (c *Client) ListEphemerides(ctx context.Context, params *ListEphemeridesInput, optFns ...func(*Options)) (*ListEphemeridesOutput, error)

List existing ephemerides.

func (*Client) ListGroundStations 

func (c *Client) ListGroundStations(ctx context.Context, params *ListGroundStationsInput, optFns ...func(*Options)) (*ListGroundStationsOutput, error)

Returns a list of ground stations.

func (*Client) ListMissionProfiles 

func (c *Client) ListMissionProfiles(ctx context.Context, params *ListMissionProfilesInput, optFns ...func(*Options)) (*ListMissionProfilesOutput, error)

Returns a list of mission profiles.

func (*Client) ListSatellites 

func (c *Client) ListSatellites(ctx context.Context, params *ListSatellitesInput, optFns ...func(*Options)) (*ListSatellitesOutput, error)

Returns a list of satellites.

func (*Client) ListTagsForResource 

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

Returns a list of tags for a specified resource.

func (*Client) Options added in v1.23.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) RegisterAgent added in v1.17.0 

func (c *Client) RegisterAgent(ctx context.Context, params *RegisterAgentInput, optFns ...func(*Options)) (*RegisterAgentOutput, error)

For use by AWS Ground Station Agent and shouldn't be called directly. Registers a new agent with AWS Ground Station.

func (*Client) ReserveContact 

func (c *Client) ReserveContact(ctx context.Context, params *ReserveContactInput, optFns ...func(*Options)) (*ReserveContactOutput, error)

Reserves a contact using specified parameters.

func (*Client) TagResource 

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

Assigns a tag to a resource.

func (*Client) UntagResource 

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

Deassigns a resource tag.

func (*Client) UpdateAgentStatus added in v1.17.0 

func (c *Client) UpdateAgentStatus(ctx context.Context, params *UpdateAgentStatusInput, optFns ...func(*Options)) (*UpdateAgentStatusOutput, error)

For use by AWS Ground Station Agent and shouldn't be called directly. Update the status of the agent.

func (*Client) UpdateConfig 

func (c *Client) UpdateConfig(ctx context.Context, params *UpdateConfigInput, optFns ...func(*Options)) (*UpdateConfigOutput, error)

Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config .

func (*Client) UpdateEphemeris added in v1.14.0 

func (c *Client) UpdateEphemeris(ctx context.Context, params *UpdateEphemerisInput, optFns ...func(*Options)) (*UpdateEphemerisOutput, error)

Updates an existing ephemeris

func (*Client) UpdateMissionProfile 

func (c *Client) UpdateMissionProfile(ctx context.Context, params *UpdateMissionProfileInput, optFns ...func(*Options)) (*UpdateMissionProfileOutput, error)

Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.

type ContactScheduledWaiter added in v1.16.0 

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

ContactScheduledWaiter defines the waiters for ContactScheduled

func NewContactScheduledWaiter added in v1.16.0 

func NewContactScheduledWaiter(client DescribeContactAPIClient, optFns ...func(*ContactScheduledWaiterOptions)) *ContactScheduledWaiter

NewContactScheduledWaiter constructs a ContactScheduledWaiter.

func (*ContactScheduledWaiter) Wait added in v1.16.0 

func (w *ContactScheduledWaiter) Wait(ctx context.Context, params *DescribeContactInput, maxWaitDur time.Duration, optFns ...func(*ContactScheduledWaiterOptions)) error

Wait calls the waiter function for ContactScheduled waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ContactScheduledWaiter) WaitForOutput added in v1.16.0 

func (w *ContactScheduledWaiter) WaitForOutput(ctx context.Context, params *DescribeContactInput, maxWaitDur time.Duration, optFns ...func(*ContactScheduledWaiterOptions)) (*DescribeContactOutput, error)

WaitForOutput calls the waiter function for ContactScheduled waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ContactScheduledWaiterOptions added in v1.16.0 

type ContactScheduledWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ContactScheduledWaiter will use default minimum delay of 5 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ContactScheduledWaiter will use default max delay of 900 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeContactInput, *DescribeContactOutput, error) (bool, error)
}

ContactScheduledWaiterOptions are waiter options for ContactScheduledWaiter

type CreateConfigInput 

type CreateConfigInput struct {

	// Parameters of a Config .
	//
	// This member is required.
	ConfigData types.ConfigTypeData

	// Name of a Config .
	//
	// This member is required.
	Name *string

	// Tags assigned to a Config .
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateConfigOutput 

type CreateConfigOutput struct {

	// ARN of a Config .
	ConfigArn *string

	// UUID of a Config .
	ConfigId *string

	// Type of a Config .
	ConfigType types.ConfigCapabilityType

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

type CreateDataflowEndpointGroupInput 

type CreateDataflowEndpointGroupInput struct {

	// Endpoint details of each endpoint in the dataflow endpoint group.
	//
	// This member is required.
	EndpointDetails []types.EndpointDetails

	// Amount of time, in seconds, after a contact ends that the Ground Station
	// Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow
	// Endpoint Group State Change event will be emitted when the Dataflow Endpoint
	// Group enters and exits the POSTPASS state.
	ContactPostPassDurationSeconds *int32

	// Amount of time, in seconds, before a contact starts that the Ground Station
	// Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow
	// Endpoint Group State Change event will be emitted when the Dataflow Endpoint
	// Group enters and exits the PREPASS state.
	ContactPrePassDurationSeconds *int32

	// Tags of a dataflow endpoint group.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDataflowEndpointGroupOutput 

type CreateDataflowEndpointGroupOutput struct {

	// UUID of a dataflow endpoint group.
	DataflowEndpointGroupId *string

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

type CreateEphemerisInput added in v1.14.0 

type CreateEphemerisInput struct {

	// A name string associated with the ephemeris. Used as a human-readable
	// identifier for the ephemeris.
	//
	// This member is required.
	Name *string

	// AWS Ground Station satellite ID for this ephemeris.
	//
	// This member is required.
	SatelliteId *string

	// Whether to set the ephemeris status to ENABLED after validation. Setting this
	// to false will set the ephemeris status to DISABLED after validation.
	Enabled *bool

	// Ephemeris data.
	Ephemeris types.EphemerisData

	// An overall expiration time for the ephemeris in UTC, after which it will become
	// EXPIRED .
	ExpirationTime *time.Time

	// The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
	KmsKeyArn *string

	// Customer-provided priority score to establish the order in which overlapping
	// ephemerides should be used. The default for customer-provided ephemeris priority
	// is 1, and higher numbers take precedence. Priority must be 1 or greater
	Priority *int32

	// Tags assigned to an ephemeris.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateEphemerisOutput added in v1.14.0 

type CreateEphemerisOutput struct {

	// The AWS Ground Station ephemeris ID.
	EphemerisId *string

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

type CreateMissionProfileInput 

type CreateMissionProfileInput struct {

	// A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a
	// to Config .
	//
	// This member is required.
	DataflowEdges [][]string

	// Smallest amount of time in seconds that you’d like to see for an available
	// contact. AWS Ground Station will not present you with contacts shorter than this
	// duration.
	//
	// This member is required.
	MinimumViableContactDurationSeconds *int32

	// Name of a mission profile.
	//
	// This member is required.
	Name *string

	// ARN of a tracking Config .
	//
	// This member is required.
	TrackingConfigArn *string

	// Amount of time after a contact ends that you’d like to receive a Ground Station
	// Contact State Change event indicating the pass has finished.
	ContactPostPassDurationSeconds *int32

	// Amount of time prior to contact start you’d like to receive a Ground Station
	// Contact State Change event indicating an upcoming pass.
	ContactPrePassDurationSeconds *int32

	// KMS key to use for encrypting streams.
	StreamsKmsKey types.KmsKey

	// Role to use for encrypting streams with KMS key.
	StreamsKmsRole *string

	// Tags assigned to a mission profile.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateMissionProfileOutput 

type CreateMissionProfileOutput struct {

	// UUID of a mission profile.
	MissionProfileId *string

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

type DeleteConfigInput 

type DeleteConfigInput struct {

	// UUID of a Config .
	//
	// This member is required.
	ConfigId *string

	// Type of a Config .
	//
	// This member is required.
	ConfigType types.ConfigCapabilityType
	// contains filtered or unexported fields
}

type DeleteConfigOutput 

type DeleteConfigOutput struct {

	// ARN of a Config .
	ConfigArn *string

	// UUID of a Config .
	ConfigId *string

	// Type of a Config .
	ConfigType types.ConfigCapabilityType

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

type DeleteDataflowEndpointGroupInput 

type DeleteDataflowEndpointGroupInput struct {

	// UUID of a dataflow endpoint group.
	//
	// This member is required.
	DataflowEndpointGroupId *string
	// contains filtered or unexported fields
}

type DeleteDataflowEndpointGroupOutput 

type DeleteDataflowEndpointGroupOutput struct {

	// UUID of a dataflow endpoint group.
	DataflowEndpointGroupId *string

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

type DeleteEphemerisInput added in v1.14.0 

type DeleteEphemerisInput struct {

	// The AWS Ground Station ephemeris ID.
	//
	// This member is required.
	EphemerisId *string
	// contains filtered or unexported fields
}

type DeleteEphemerisOutput added in v1.14.0 

type DeleteEphemerisOutput struct {

	// The AWS Ground Station ephemeris ID.
	EphemerisId *string

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

type DeleteMissionProfileInput 

type DeleteMissionProfileInput struct {

	// UUID of a mission profile.
	//
	// This member is required.
	MissionProfileId *string
	// contains filtered or unexported fields
}

type DeleteMissionProfileOutput 

type DeleteMissionProfileOutput struct {

	// UUID of a mission profile.
	MissionProfileId *string

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

type DescribeContactAPIClient added in v1.16.0 

type DescribeContactAPIClient interface {
	DescribeContact(context.Context, *DescribeContactInput, ...func(*Options)) (*DescribeContactOutput, error)
}

DescribeContactAPIClient is a client that implements the DescribeContact operation.

type DescribeContactInput 

type DescribeContactInput struct {

	// UUID of a contact.
	//
	// This member is required.
	ContactId *string
	// contains filtered or unexported fields
}

type DescribeContactOutput 

type DescribeContactOutput struct {

	// UUID of a contact.
	ContactId *string

	// Status of a contact.
	ContactStatus types.ContactStatus

	// List describing source and destination details for each dataflow edge.
	DataflowList []types.DataflowDetail

	// End time of a contact in UTC.
	EndTime *time.Time

	// Error message for a contact.
	ErrorMessage *string

	// Ground station for a contact.
	GroundStation *string

	// Maximum elevation angle of a contact.
	MaximumElevation *types.Elevation

	// ARN of a mission profile.
	MissionProfileArn *string

	// Amount of time after a contact ends that you’d like to receive a CloudWatch
	// event indicating the pass has finished.
	PostPassEndTime *time.Time

	// Amount of time prior to contact start you’d like to receive a CloudWatch event
	// indicating an upcoming pass.
	PrePassStartTime *time.Time

	// Region of a contact.
	Region *string

	// ARN of a satellite.
	SatelliteArn *string

	// Start time of a contact in UTC.
	StartTime *time.Time

	// Tags assigned to a contact.
	Tags map[string]string

	// Projected time in UTC your satellite will set below the receive mask (https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html)
	// . This time is based on the satellite's current active ephemeris for future
	// contacts and the ephemeris that was active during contact execution for
	// completed contacts.
	VisibilityEndTime *time.Time

	// Projected time in UTC your satellite will rise above the receive mask (https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html)
	// . This time is based on the satellite's current active ephemeris for future
	// contacts and the ephemeris that was active during contact execution for
	// completed contacts.
	VisibilityStartTime *time.Time

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

type DescribeEphemerisInput added in v1.14.0 

type DescribeEphemerisInput struct {

	// The AWS Ground Station ephemeris ID.
	//
	// This member is required.
	EphemerisId *string
	// contains filtered or unexported fields
}

type DescribeEphemerisOutput added in v1.14.0 

type DescribeEphemerisOutput struct {

	// The time the ephemeris was uploaded in UTC.
	CreationTime *time.Time

	// Whether or not the ephemeris is enabled.
	Enabled *bool

	// The AWS Ground Station ephemeris ID.
	EphemerisId *string

	// Reason that an ephemeris failed validation. Only provided for ephemerides with
	// INVALID status.
	InvalidReason types.EphemerisInvalidReason

	// A name string associated with the ephemeris. Used as a human-readable
	// identifier for the ephemeris.
	Name *string

	// Customer-provided priority score to establish the order in which overlapping
	// ephemerides should be used. The default for customer-provided ephemeris priority
	// is 1, and higher numbers take precedence. Priority must be 1 or greater
	Priority *int32

	// The AWS Ground Station satellite ID associated with ephemeris.
	SatelliteId *string

	// The status of the ephemeris.
	Status types.EphemerisStatus

	// Supplied ephemeris data.
	SuppliedData types.EphemerisTypeDescription

	// Tags assigned to an ephemeris.
	Tags map[string]string

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

type EndpointParameters added in v1.19.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.19.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.19.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 added in v1.1.0 

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 added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.19.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.19.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAgentConfigurationInput added in v1.17.0 

type GetAgentConfigurationInput struct {

	// UUID of agent to get configuration information for.
	//
	// This member is required.
	AgentId *string
	// contains filtered or unexported fields
}

type GetAgentConfigurationOutput added in v1.17.0 

type GetAgentConfigurationOutput struct {

	// UUID of agent.
	AgentId *string

	// Tasking document for agent.
	TaskingDocument *string

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

type GetConfigInput 

type GetConfigInput struct {

	// UUID of a Config .
	//
	// This member is required.
	ConfigId *string

	// Type of a Config .
	//
	// This member is required.
	ConfigType types.ConfigCapabilityType
	// contains filtered or unexported fields
}

type GetConfigOutput 

type GetConfigOutput struct {

	// ARN of a Config
	//
	// This member is required.
	ConfigArn *string

	// Data elements in a Config .
	//
	// This member is required.
	ConfigData types.ConfigTypeData

	// UUID of a Config .
	//
	// This member is required.
	ConfigId *string

	// Name of a Config .
	//
	// This member is required.
	Name *string

	// Type of a Config .
	ConfigType types.ConfigCapabilityType

	// Tags assigned to a Config .
	Tags map[string]string

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

type GetDataflowEndpointGroupInput 

type GetDataflowEndpointGroupInput struct {

	// UUID of a dataflow endpoint group.
	//
	// This member is required.
	DataflowEndpointGroupId *string
	// contains filtered or unexported fields
}

type GetDataflowEndpointGroupOutput 

type GetDataflowEndpointGroupOutput struct {

	// Amount of time, in seconds, after a contact ends that the Ground Station
	// Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow
	// Endpoint Group State Change event will be emitted when the Dataflow Endpoint
	// Group enters and exits the POSTPASS state.
	ContactPostPassDurationSeconds *int32

	// Amount of time, in seconds, before a contact starts that the Ground Station
	// Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow
	// Endpoint Group State Change event will be emitted when the Dataflow Endpoint
	// Group enters and exits the PREPASS state.
	ContactPrePassDurationSeconds *int32

	// ARN of a dataflow endpoint group.
	DataflowEndpointGroupArn *string

	// UUID of a dataflow endpoint group.
	DataflowEndpointGroupId *string

	// Details of a dataflow endpoint.
	EndpointsDetails []types.EndpointDetails

	// Tags assigned to a dataflow endpoint group.
	Tags map[string]string

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

type GetMinuteUsageInput 

type GetMinuteUsageInput struct {

	// The month being requested, with a value of 1-12.
	//
	// This member is required.
	Month *int32

	// The year being requested, in the format of YYYY.
	//
	// This member is required.
	Year *int32
	// contains filtered or unexported fields
}

type GetMinuteUsageOutput 

type GetMinuteUsageOutput struct {

	// Estimated number of minutes remaining for an account, specific to the month
	// being requested.
	EstimatedMinutesRemaining *int32

	// Returns whether or not an account has signed up for the reserved minutes
	// pricing plan, specific to the month being requested.
	IsReservedMinutesCustomer *bool

	// Total number of reserved minutes allocated, specific to the month being
	// requested.
	TotalReservedMinuteAllocation *int32

	// Total scheduled minutes for an account, specific to the month being requested.
	TotalScheduledMinutes *int32

	// Upcoming minutes scheduled for an account, specific to the month being
	// requested.
	UpcomingMinutesScheduled *int32

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

type GetMissionProfileInput 

type GetMissionProfileInput struct {

	// UUID of a mission profile.
	//
	// This member is required.
	MissionProfileId *string
	// contains filtered or unexported fields
}

type GetMissionProfileOutput 

type GetMissionProfileOutput struct {

	// Amount of time after a contact ends that you’d like to receive a CloudWatch
	// event indicating the pass has finished.
	ContactPostPassDurationSeconds *int32

	// Amount of time prior to contact start you’d like to receive a CloudWatch event
	// indicating an upcoming pass.
	ContactPrePassDurationSeconds *int32

	// A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a
	// to Config .
	DataflowEdges [][]string

	// Smallest amount of time in seconds that you’d like to see for an available
	// contact. AWS Ground Station will not present you with contacts shorter than this
	// duration.
	MinimumViableContactDurationSeconds *int32

	// ARN of a mission profile.
	MissionProfileArn *string

	// UUID of a mission profile.
	MissionProfileId *string

	// Name of a mission profile.
	Name *string

	// Region of a mission profile.
	Region *string

	// KMS key to use for encrypting streams.
	StreamsKmsKey types.KmsKey

	// Role to use for encrypting streams with KMS key.
	StreamsKmsRole *string

	// Tags assigned to a mission profile.
	Tags map[string]string

	// ARN of a tracking Config .
	TrackingConfigArn *string

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

type GetSatelliteInput 

type GetSatelliteInput struct {

	// UUID of a satellite.
	//
	// This member is required.
	SatelliteId *string
	// contains filtered or unexported fields
}

type GetSatelliteOutput 

type GetSatelliteOutput struct {

	// The current ephemeris being used to compute the trajectory of the satellite.
	CurrentEphemeris *types.EphemerisMetaData

	// A list of ground stations to which the satellite is on-boarded.
	GroundStations []string

	// NORAD satellite ID number.
	NoradSatelliteID int32

	// ARN of a satellite.
	SatelliteArn *string

	// UUID of a satellite.
	SatelliteId *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 ListConfigsAPIClient added in v0.30.0 

type ListConfigsAPIClient interface {
	ListConfigs(context.Context, *ListConfigsInput, ...func(*Options)) (*ListConfigsOutput, error)
}

ListConfigsAPIClient is a client that implements the ListConfigs operation.

type ListConfigsInput 

type ListConfigsInput struct {

	// Maximum number of Configs returned.
	MaxResults *int32

	// Next token returned in the request of a previous ListConfigs call. Used to get
	// the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListConfigsOutput 

type ListConfigsOutput struct {

	// List of Config items.
	ConfigList []types.ConfigListItem

	// Next token returned in the response of a previous ListConfigs call. Used to get
	// the next page of results.
	NextToken *string

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

type ListConfigsPaginator added in v0.30.0 

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

ListConfigsPaginator is a paginator for ListConfigs

func NewListConfigsPaginator added in v0.30.0 

func NewListConfigsPaginator(client ListConfigsAPIClient, params *ListConfigsInput, optFns ...func(*ListConfigsPaginatorOptions)) *ListConfigsPaginator

NewListConfigsPaginator returns a new ListConfigsPaginator

func (*ListConfigsPaginator) HasMorePages added in v0.30.0 

func (p *ListConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConfigsPaginator) NextPage added in v0.30.0 

func (p *ListConfigsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConfigsOutput, error)

NextPage retrieves the next ListConfigs page.

type ListConfigsPaginatorOptions added in v0.30.0 

type ListConfigsPaginatorOptions struct {
	// Maximum number of Configs returned.
	Limit int32

	// 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
}

ListConfigsPaginatorOptions is the paginator options for ListConfigs

type ListContactsAPIClient added in v0.30.0 

type ListContactsAPIClient interface {
	ListContacts(context.Context, *ListContactsInput, ...func(*Options)) (*ListContactsOutput, error)
}

ListContactsAPIClient is a client that implements the ListContacts operation.

type ListContactsInput 

type ListContactsInput struct {

	// End time of a contact in UTC.
	//
	// This member is required.
	EndTime *time.Time

	// Start time of a contact in UTC.
	//
	// This member is required.
	StartTime *time.Time

	// Status of a contact reservation.
	//
	// This member is required.
	StatusList []types.ContactStatus

	// Name of a ground station.
	GroundStation *string

	// Maximum number of contacts returned.
	MaxResults *int32

	// ARN of a mission profile.
	MissionProfileArn *string

	// Next token returned in the request of a previous ListContacts call. Used to get
	// the next page of results.
	NextToken *string

	// ARN of a satellite.
	SatelliteArn *string
	// contains filtered or unexported fields
}

type ListContactsOutput 

type ListContactsOutput struct {

	// List of contacts.
	ContactList []types.ContactData

	// Next token returned in the response of a previous ListContacts call. Used to
	// get the next page of results.
	NextToken *string

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

type ListContactsPaginator added in v0.30.0 

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

ListContactsPaginator is a paginator for ListContacts

func NewListContactsPaginator added in v0.30.0 

func NewListContactsPaginator(client ListContactsAPIClient, params *ListContactsInput, optFns ...func(*ListContactsPaginatorOptions)) *ListContactsPaginator

NewListContactsPaginator returns a new ListContactsPaginator

func (*ListContactsPaginator) HasMorePages added in v0.30.0 

func (p *ListContactsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactsPaginator) NextPage added in v0.30.0 

func (p *ListContactsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactsOutput, error)

NextPage retrieves the next ListContacts page.

type ListContactsPaginatorOptions added in v0.30.0 

type ListContactsPaginatorOptions struct {
	// Maximum number of contacts returned.
	Limit int32

	// 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
}

ListContactsPaginatorOptions is the paginator options for ListContacts

type ListDataflowEndpointGroupsAPIClient added in v0.30.0 

type ListDataflowEndpointGroupsAPIClient interface {
	ListDataflowEndpointGroups(context.Context, *ListDataflowEndpointGroupsInput, ...func(*Options)) (*ListDataflowEndpointGroupsOutput, error)
}

ListDataflowEndpointGroupsAPIClient is a client that implements the ListDataflowEndpointGroups operation.

type ListDataflowEndpointGroupsInput 

type ListDataflowEndpointGroupsInput struct {

	// Maximum number of dataflow endpoint groups returned.
	MaxResults *int32

	// Next token returned in the request of a previous ListDataflowEndpointGroups
	// call. Used to get the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDataflowEndpointGroupsOutput 

type ListDataflowEndpointGroupsOutput struct {

	// A list of dataflow endpoint groups.
	DataflowEndpointGroupList []types.DataflowEndpointListItem

	// Next token returned in the response of a previous ListDataflowEndpointGroups
	// call. Used to get the next page of results.
	NextToken *string

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

type ListDataflowEndpointGroupsPaginator added in v0.30.0 

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

ListDataflowEndpointGroupsPaginator is a paginator for ListDataflowEndpointGroups

func NewListDataflowEndpointGroupsPaginator added in v0.30.0 

func NewListDataflowEndpointGroupsPaginator(client ListDataflowEndpointGroupsAPIClient, params *ListDataflowEndpointGroupsInput, optFns ...func(*ListDataflowEndpointGroupsPaginatorOptions)) *ListDataflowEndpointGroupsPaginator

NewListDataflowEndpointGroupsPaginator returns a new ListDataflowEndpointGroupsPaginator

func (*ListDataflowEndpointGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListDataflowEndpointGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataflowEndpointGroupsPaginator) NextPage added in v0.30.0 

func (p *ListDataflowEndpointGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataflowEndpointGroupsOutput, error)

NextPage retrieves the next ListDataflowEndpointGroups page.

type ListDataflowEndpointGroupsPaginatorOptions added in v0.30.0 

type ListDataflowEndpointGroupsPaginatorOptions struct {
	// Maximum number of dataflow endpoint groups returned.
	Limit int32

	// 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
}

ListDataflowEndpointGroupsPaginatorOptions is the paginator options for ListDataflowEndpointGroups

type ListEphemeridesAPIClient added in v1.14.0 

type ListEphemeridesAPIClient interface {
	ListEphemerides(context.Context, *ListEphemeridesInput, ...func(*Options)) (*ListEphemeridesOutput, error)
}

ListEphemeridesAPIClient is a client that implements the ListEphemerides operation.

type ListEphemeridesInput added in v1.14.0 

type ListEphemeridesInput struct {

	// The end time to list in UTC. The operation will return an ephemeris if its
	// expiration time is within the time range defined by the startTime and endTime .
	//
	// This member is required.
	EndTime *time.Time

	// The AWS Ground Station satellite ID to list ephemeris for.
	//
	// This member is required.
	SatelliteId *string

	// The start time to list in UTC. The operation will return an ephemeris if its
	// expiration time is within the time range defined by the startTime and endTime .
	//
	// This member is required.
	StartTime *time.Time

	// Maximum number of ephemerides to return.
	MaxResults *int32

	// Pagination token.
	NextToken *string

	// The list of ephemeris status to return.
	StatusList []types.EphemerisStatus
	// contains filtered or unexported fields
}

type ListEphemeridesOutput added in v1.14.0 

type ListEphemeridesOutput struct {

	// List of ephemerides.
	Ephemerides []types.EphemerisItem

	// Pagination token.
	NextToken *string

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

type ListEphemeridesPaginator added in v1.14.0 

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

ListEphemeridesPaginator is a paginator for ListEphemerides

func NewListEphemeridesPaginator added in v1.14.0 

func NewListEphemeridesPaginator(client ListEphemeridesAPIClient, params *ListEphemeridesInput, optFns ...func(*ListEphemeridesPaginatorOptions)) *ListEphemeridesPaginator

NewListEphemeridesPaginator returns a new ListEphemeridesPaginator

func (*ListEphemeridesPaginator) HasMorePages added in v1.14.0 

func (p *ListEphemeridesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEphemeridesPaginator) NextPage added in v1.14.0 

func (p *ListEphemeridesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEphemeridesOutput, error)

NextPage retrieves the next ListEphemerides page.

type ListEphemeridesPaginatorOptions added in v1.14.0 

type ListEphemeridesPaginatorOptions struct {
	// Maximum number of ephemerides to return.
	Limit int32

	// 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
}

ListEphemeridesPaginatorOptions is the paginator options for ListEphemerides

type ListGroundStationsAPIClient added in v0.30.0 

type ListGroundStationsAPIClient interface {
	ListGroundStations(context.Context, *ListGroundStationsInput, ...func(*Options)) (*ListGroundStationsOutput, error)
}

ListGroundStationsAPIClient is a client that implements the ListGroundStations operation.

type ListGroundStationsInput 

type ListGroundStationsInput struct {

	// Maximum number of ground stations returned.
	MaxResults *int32

	// Next token that can be supplied in the next call to get the next page of ground
	// stations.
	NextToken *string

	// Satellite ID to retrieve on-boarded ground stations.
	SatelliteId *string
	// contains filtered or unexported fields
}

type ListGroundStationsOutput 

type ListGroundStationsOutput struct {

	// List of ground stations.
	GroundStationList []types.GroundStationData

	// Next token that can be supplied in the next call to get the next page of ground
	// stations.
	NextToken *string

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

type ListGroundStationsPaginator added in v0.30.0 

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

ListGroundStationsPaginator is a paginator for ListGroundStations

func NewListGroundStationsPaginator added in v0.30.0 

func NewListGroundStationsPaginator(client ListGroundStationsAPIClient, params *ListGroundStationsInput, optFns ...func(*ListGroundStationsPaginatorOptions)) *ListGroundStationsPaginator

NewListGroundStationsPaginator returns a new ListGroundStationsPaginator

func (*ListGroundStationsPaginator) HasMorePages added in v0.30.0 

func (p *ListGroundStationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroundStationsPaginator) NextPage added in v0.30.0 

func (p *ListGroundStationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroundStationsOutput, error)

NextPage retrieves the next ListGroundStations page.

type ListGroundStationsPaginatorOptions added in v0.30.0 

type ListGroundStationsPaginatorOptions struct {
	// Maximum number of ground stations returned.
	Limit int32

	// 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
}

ListGroundStationsPaginatorOptions is the paginator options for ListGroundStations

type ListMissionProfilesAPIClient added in v0.30.0 

type ListMissionProfilesAPIClient interface {
	ListMissionProfiles(context.Context, *ListMissionProfilesInput, ...func(*Options)) (*ListMissionProfilesOutput, error)
}

ListMissionProfilesAPIClient is a client that implements the ListMissionProfiles operation.

type ListMissionProfilesInput 

type ListMissionProfilesInput struct {

	// Maximum number of mission profiles returned.
	MaxResults *int32

	// Next token returned in the request of a previous ListMissionProfiles call. Used
	// to get the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMissionProfilesOutput 

type ListMissionProfilesOutput struct {

	// List of mission profiles.
	MissionProfileList []types.MissionProfileListItem

	// Next token returned in the response of a previous ListMissionProfiles call.
	// Used to get the next page of results.
	NextToken *string

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

type ListMissionProfilesPaginator added in v0.30.0 

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

ListMissionProfilesPaginator is a paginator for ListMissionProfiles

func NewListMissionProfilesPaginator added in v0.30.0 

func NewListMissionProfilesPaginator(client ListMissionProfilesAPIClient, params *ListMissionProfilesInput, optFns ...func(*ListMissionProfilesPaginatorOptions)) *ListMissionProfilesPaginator

NewListMissionProfilesPaginator returns a new ListMissionProfilesPaginator

func (*ListMissionProfilesPaginator) HasMorePages added in v0.30.0 

func (p *ListMissionProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMissionProfilesPaginator) NextPage added in v0.30.0 

func (p *ListMissionProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMissionProfilesOutput, error)

NextPage retrieves the next ListMissionProfiles page.

type ListMissionProfilesPaginatorOptions added in v0.30.0 

type ListMissionProfilesPaginatorOptions struct {
	// Maximum number of mission profiles returned.
	Limit int32

	// 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
}

ListMissionProfilesPaginatorOptions is the paginator options for ListMissionProfiles

type ListSatellitesAPIClient added in v0.30.0 

type ListSatellitesAPIClient interface {
	ListSatellites(context.Context, *ListSatellitesInput, ...func(*Options)) (*ListSatellitesOutput, error)
}

ListSatellitesAPIClient is a client that implements the ListSatellites operation.

type ListSatellitesInput 

type ListSatellitesInput struct {

	// Maximum number of satellites returned.
	MaxResults *int32

	// Next token that can be supplied in the next call to get the next page of
	// satellites.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSatellitesOutput 

type ListSatellitesOutput struct {

	// Next token that can be supplied in the next call to get the next page of
	// satellites.
	NextToken *string

	// List of satellites.
	Satellites []types.SatelliteListItem

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

type ListSatellitesPaginator added in v0.30.0 

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

ListSatellitesPaginator is a paginator for ListSatellites

func NewListSatellitesPaginator added in v0.30.0 

func NewListSatellitesPaginator(client ListSatellitesAPIClient, params *ListSatellitesInput, optFns ...func(*ListSatellitesPaginatorOptions)) *ListSatellitesPaginator

NewListSatellitesPaginator returns a new ListSatellitesPaginator

func (*ListSatellitesPaginator) HasMorePages added in v0.30.0 

func (p *ListSatellitesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSatellitesPaginator) NextPage added in v0.30.0 

func (p *ListSatellitesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSatellitesOutput, error)

NextPage retrieves the next ListSatellites page.

type ListSatellitesPaginatorOptions added in v0.30.0 

type ListSatellitesPaginatorOptions struct {
	// Maximum number of satellites returned.
	Limit int32

	// 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
}

ListSatellitesPaginatorOptions is the paginator options for ListSatellites

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// ARN of a resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Tags assigned to a resource.
	Tags map[string]string

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

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

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

	// 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 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.22.2 

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

type RegisterAgentInput added in v1.17.0 

type RegisterAgentInput struct {

	// Detailed information about the agent being registered.
	//
	// This member is required.
	AgentDetails *types.AgentDetails

	// Data for associating an agent with the capabilities it is managing.
	//
	// This member is required.
	DiscoveryData *types.DiscoveryData
	// contains filtered or unexported fields
}

type RegisterAgentOutput added in v1.17.0 

type RegisterAgentOutput struct {

	// UUID of registered agent.
	AgentId *string

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

type ReserveContactInput 

type ReserveContactInput struct {

	// End time of a contact in UTC.
	//
	// This member is required.
	EndTime *time.Time

	// Name of a ground station.
	//
	// This member is required.
	GroundStation *string

	// ARN of a mission profile.
	//
	// This member is required.
	MissionProfileArn *string

	// ARN of a satellite
	//
	// This member is required.
	SatelliteArn *string

	// Start time of a contact in UTC.
	//
	// This member is required.
	StartTime *time.Time

	// Tags assigned to a contact.
	Tags map[string]string
	// contains filtered or unexported fields
}

type ReserveContactOutput 

type ReserveContactOutput struct {

	// UUID of a contact.
	ContactId *string

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

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 TagResourceInput 

type TagResourceInput struct {

	// ARN of a resource tag.
	//
	// This member is required.
	ResourceArn *string

	// Tags assigned to a resource.
	//
	// 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 {

	// ARN of a resource.
	//
	// This member is required.
	ResourceArn *string

	// Keys of a resource tag.
	//
	// 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
}

type UpdateAgentStatusInput added in v1.17.0 

type UpdateAgentStatusInput struct {

	// UUID of agent to update.
	//
	// This member is required.
	AgentId *string

	// Aggregate status for agent.
	//
	// This member is required.
	AggregateStatus *types.AggregateStatus

	// List of component statuses for agent.
	//
	// This member is required.
	ComponentStatuses []types.ComponentStatusData

	// GUID of agent task.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type UpdateAgentStatusOutput added in v1.17.0 

type UpdateAgentStatusOutput struct {

	// UUID of updated agent.
	//
	// This member is required.
	AgentId *string

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

type UpdateConfigInput 

type UpdateConfigInput struct {

	// Parameters of a Config .
	//
	// This member is required.
	ConfigData types.ConfigTypeData

	// UUID of a Config .
	//
	// This member is required.
	ConfigId *string

	// Type of a Config .
	//
	// This member is required.
	ConfigType types.ConfigCapabilityType

	// Name of a Config .
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type UpdateConfigOutput 

type UpdateConfigOutput struct {

	// ARN of a Config .
	ConfigArn *string

	// UUID of a Config .
	ConfigId *string

	// Type of a Config .
	ConfigType types.ConfigCapabilityType

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

type UpdateEphemerisInput added in v1.14.0 

type UpdateEphemerisInput struct {

	// Whether the ephemeris is enabled or not. Changing this value will not require
	// the ephemeris to be re-validated.
	//
	// This member is required.
	Enabled *bool

	// The AWS Ground Station ephemeris ID.
	//
	// This member is required.
	EphemerisId *string

	// A name string associated with the ephemeris. Used as a human-readable
	// identifier for the ephemeris.
	Name *string

	// Customer-provided priority score to establish the order in which overlapping
	// ephemerides should be used. The default for customer-provided ephemeris priority
	// is 1, and higher numbers take precedence. Priority must be 1 or greater
	Priority *int32
	// contains filtered or unexported fields
}

type UpdateEphemerisOutput added in v1.14.0 

type UpdateEphemerisOutput struct {

	// The AWS Ground Station ephemeris ID.
	EphemerisId *string

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

type UpdateMissionProfileInput 

type UpdateMissionProfileInput struct {

	// UUID of a mission profile.
	//
	// This member is required.
	MissionProfileId *string

	// Amount of time after a contact ends that you’d like to receive a Ground Station
	// Contact State Change event indicating the pass has finished.
	ContactPostPassDurationSeconds *int32

	// Amount of time after a contact ends that you’d like to receive a Ground Station
	// Contact State Change event indicating the pass has finished.
	ContactPrePassDurationSeconds *int32

	// A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a
	// to Config .
	DataflowEdges [][]string

	// Smallest amount of time in seconds that you’d like to see for an available
	// contact. AWS Ground Station will not present you with contacts shorter than this
	// duration.
	MinimumViableContactDurationSeconds *int32

	// Name of a mission profile.
	Name *string

	// KMS key to use for encrypting streams.
	StreamsKmsKey types.KmsKey

	// Role to use for encrypting streams with KMS key.
	StreamsKmsRole *string

	// ARN of a tracking Config .
	TrackingConfigArn *string
	// contains filtered or unexported fields
}

type UpdateMissionProfileOutput 

type UpdateMissionProfileOutput struct {

	// UUID of a mission profile.
	MissionProfileId *string

	// 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.