groundstation – github.com/aws/aws-sdk-go-v2/service/groundstation Index | Files | Directories

package groundstation

import "github.com/aws/aws-sdk-go-v2/service/groundstation"

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

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

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

Types

type CancelContactInput

type CancelContactInput struct {

	// UUID of a contact.
	//
	// This member is required.
	ContactId *string
}

type CancelContactOutput

type CancelContactOutput struct {

	// UUID of a contact.
	ContactId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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
}

type CreateDataflowEndpointGroupInput

type CreateDataflowEndpointGroupInput struct {

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

	// Tags of a dataflow endpoint group.
	Tags map[string]string
}

type CreateDataflowEndpointGroupOutput

type CreateDataflowEndpointGroupOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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

type CreateMissionProfileOutput

type CreateMissionProfileOutput struct {

	// UUID of a mission profile.
	MissionProfileId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

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
}

type DeleteDataflowEndpointGroupInput

type DeleteDataflowEndpointGroupInput struct {

	// UUID of a dataflow endpoint group.
	//
	// This member is required.
	DataflowEndpointGroupId *string
}

type DeleteDataflowEndpointGroupOutput

type DeleteDataflowEndpointGroupOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteMissionProfileInput

type DeleteMissionProfileInput struct {

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

type DeleteMissionProfileOutput

type DeleteMissionProfileOutput struct {

	// UUID of a mission profile.
	MissionProfileId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeContactInput

type DescribeContactInput struct {

	// UUID of a contact.
	//
	// This member is required.
	ContactId *string
}

type DescribeContactOutput

type DescribeContactOutput struct {

	// UUID of a contact.
	ContactId *string

	// Status of a contact.
	ContactStatus types.ContactStatus

	// End time of a contact.
	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.
	StartTime *time.Time

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

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

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
}

type GetDataflowEndpointGroupInput

type GetDataflowEndpointGroupInput struct {

	// UUID of a dataflow endpoint group.
	//
	// This member is required.
	DataflowEndpointGroupId *string
}

type GetDataflowEndpointGroupOutput

type GetDataflowEndpointGroupOutput struct {

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

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
}

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
}

type GetMissionProfileInput

type GetMissionProfileInput struct {

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

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

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

type GetSatelliteInput

type GetSatelliteInput struct {

	// UUID of a satellite.
	//
	// This member is required.
	SatelliteId *string
}

type GetSatelliteOutput

type GetSatelliteOutput struct {

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

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

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
}

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
}

type ListConfigsPaginator

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

ListConfigsPaginator is a paginator for ListConfigs

func NewListConfigsPaginator

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

NewListConfigsPaginator returns a new ListConfigsPaginator

func (*ListConfigsPaginator) HasMorePages

func (p *ListConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConfigsPaginator) NextPage

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

NextPage retrieves the next ListConfigs page.

type ListConfigsPaginatorOptions

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

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.
	//
	// This member is required.
	EndTime *time.Time

	// Start time of a contact.
	//
	// 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
}

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
}

type ListContactsPaginator

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

ListContactsPaginator is a paginator for ListContacts

func NewListContactsPaginator

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

NewListContactsPaginator returns a new ListContactsPaginator

func (*ListContactsPaginator) HasMorePages

func (p *ListContactsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactsPaginator) NextPage

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

NextPage retrieves the next ListContacts page.

type ListContactsPaginatorOptions

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

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
}

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
}

type ListDataflowEndpointGroupsPaginator

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

ListDataflowEndpointGroupsPaginator is a paginator for ListDataflowEndpointGroups

func NewListDataflowEndpointGroupsPaginator

NewListDataflowEndpointGroupsPaginator returns a new ListDataflowEndpointGroupsPaginator

func (*ListDataflowEndpointGroupsPaginator) HasMorePages

func (p *ListDataflowEndpointGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataflowEndpointGroupsPaginator) NextPage

NextPage retrieves the next ListDataflowEndpointGroups page.

type ListDataflowEndpointGroupsPaginatorOptions

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 ListGroundStationsAPIClient

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
}

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
}

type ListGroundStationsPaginator

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

ListGroundStationsPaginator is a paginator for ListGroundStations

func NewListGroundStationsPaginator

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

NewListGroundStationsPaginator returns a new ListGroundStationsPaginator

func (*ListGroundStationsPaginator) HasMorePages

func (p *ListGroundStationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroundStationsPaginator) NextPage

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

NextPage retrieves the next ListGroundStations page.

type ListGroundStationsPaginatorOptions

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

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
}

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
}

type ListMissionProfilesPaginator

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

ListMissionProfilesPaginator is a paginator for ListMissionProfiles

func NewListMissionProfilesPaginator

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

NewListMissionProfilesPaginator returns a new ListMissionProfilesPaginator

func (*ListMissionProfilesPaginator) HasMorePages

func (p *ListMissionProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMissionProfilesPaginator) NextPage

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

NextPage retrieves the next ListMissionProfiles page.

type ListMissionProfilesPaginatorOptions

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

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
}

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
}

type ListSatellitesPaginator

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

ListSatellitesPaginator is a paginator for ListSatellites

func NewListSatellitesPaginator

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

NewListSatellitesPaginator returns a new ListSatellitesPaginator

func (*ListSatellitesPaginator) HasMorePages

func (p *ListSatellitesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSatellitesPaginator) NextPage

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

NextPage retrieves the next ListSatellites page.

type ListSatellitesPaginatorOptions

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
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

	// 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 endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

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

func (Options) Copy

func (o Options) Copy() Options

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

type ReserveContactInput

type ReserveContactInput struct {

	// End time of a contact.
	//
	// 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.
	//
	// This member is required.
	StartTime *time.Time

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

type ReserveContactOutput

type ReserveContactOutput struct {

	// UUID of a contact.
	ContactId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

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
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

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
}

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 CloudWatch
	// event indicating the pass has finished.
	ContactPostPassDurationSeconds int32

	// Amount of time after a contact ends that you’d like to receive a CloudWatch
	// 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

	// ARN of a tracking Config.
	TrackingConfigArn *string
}

type UpdateMissionProfileOutput

type UpdateMissionProfileOutput struct {

	// UUID of a mission profile.
	MissionProfileId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_CancelContact.go api_op_CreateConfig.go api_op_CreateDataflowEndpointGroup.go api_op_CreateMissionProfile.go api_op_DeleteConfig.go api_op_DeleteDataflowEndpointGroup.go api_op_DeleteMissionProfile.go api_op_DescribeContact.go api_op_GetConfig.go api_op_GetDataflowEndpointGroup.go api_op_GetMinuteUsage.go api_op_GetMissionProfile.go api_op_GetSatellite.go api_op_ListConfigs.go api_op_ListContacts.go api_op_ListDataflowEndpointGroups.go api_op_ListGroundStations.go api_op_ListMissionProfiles.go api_op_ListSatellites.go api_op_ListTagsForResource.go api_op_ReserveContact.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateConfig.go api_op_UpdateMissionProfile.go deserializers.go doc.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.31.0
Published
Dec 24, 2020
Platform
js/wasm
Imports
27 packages
Last checked
now

Tools for package owners.