NAME

Paws::GroundStation - Perl Interface to AWS AWS Ground Station

SYNOPSIS

  use Paws;

  my $obj = Paws->service('GroundStation');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23

METHODS

CancelContact

ContactId => Str

Each argument is described in detail in: Paws::GroundStation::CancelContact

Returns: a Paws::GroundStation::ContactIdResponse instance

Cancels a contact with a specified contact ID.

CreateConfig

ConfigData => Paws::GroundStation::ConfigTypeData
Name => Str
[Tags => Paws::GroundStation::TagsMap]

Each argument is described in detail in: Paws::GroundStation::CreateConfig

Returns: a Paws::GroundStation::ConfigIdResponse instance

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

CreateDataflowEndpointGroup

EndpointDetails => ArrayRef[Paws::GroundStation::EndpointDetails]
[Tags => Paws::GroundStation::TagsMap]

Each argument is described in detail in: Paws::GroundStation::CreateDataflowEndpointGroup

Returns: a Paws::GroundStation::DataflowEndpointGroupIdResponse instance

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.

CreateMissionProfile

DataflowEdges => ArrayRef[ArrayRef[Str|Undef]]
MinimumViableContactDurationSeconds => Int
Name => Str
TrackingConfigArn => Str
[ContactPostPassDurationSeconds => Int]
[ContactPrePassDurationSeconds => Int]
[Tags => Paws::GroundStation::TagsMap]

Each argument is described in detail in: Paws::GroundStation::CreateMissionProfile

Returns: a Paws::GroundStation::MissionProfileIdResponse instance

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.

DeleteConfig

ConfigId => Str
ConfigType => Str

Each argument is described in detail in: Paws::GroundStation::DeleteConfig

Returns: a Paws::GroundStation::ConfigIdResponse instance

Deletes a Config.

DeleteDataflowEndpointGroup

DataflowEndpointGroupId => Str

Each argument is described in detail in: Paws::GroundStation::DeleteDataflowEndpointGroup

Returns: a Paws::GroundStation::DataflowEndpointGroupIdResponse instance

Deletes a dataflow endpoint group.

DeleteMissionProfile

MissionProfileId => Str

Each argument is described in detail in: Paws::GroundStation::DeleteMissionProfile

Returns: a Paws::GroundStation::MissionProfileIdResponse instance

Deletes a mission profile.

DescribeContact

ContactId => Str

Each argument is described in detail in: Paws::GroundStation::DescribeContact

Returns: a Paws::GroundStation::DescribeContactResponse instance

Describes an existing contact.

GetConfig

ConfigId => Str
ConfigType => Str

Each argument is described in detail in: Paws::GroundStation::GetConfig

Returns: a Paws::GroundStation::GetConfigResponse instance

Returns Config information.

Only one Config response can be returned.

GetDataflowEndpointGroup

DataflowEndpointGroupId => Str

Each argument is described in detail in: Paws::GroundStation::GetDataflowEndpointGroup

Returns: a Paws::GroundStation::GetDataflowEndpointGroupResponse instance

Returns the dataflow endpoint group.

GetMinuteUsage

Month => Int
Year => Int

Each argument is described in detail in: Paws::GroundStation::GetMinuteUsage

Returns: a Paws::GroundStation::GetMinuteUsageResponse instance

Returns the number of minutes used by account.

GetMissionProfile

MissionProfileId => Str

Each argument is described in detail in: Paws::GroundStation::GetMissionProfile

Returns: a Paws::GroundStation::GetMissionProfileResponse instance

Returns a mission profile.

GetSatellite

SatelliteId => Str

Each argument is described in detail in: Paws::GroundStation::GetSatellite

Returns: a Paws::GroundStation::GetSatelliteResponse instance

Returns a satellite.

ListConfigs

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GroundStation::ListConfigs

Returns: a Paws::GroundStation::ListConfigsResponse instance

Returns a list of Config objects.

ListContacts

EndTime => Str
StartTime => Str
StatusList => ArrayRef[Str|Undef]
[GroundStation => Str]
[MaxResults => Int]
[MissionProfileArn => Str]
[NextToken => Str]
[SatelliteArn => Str]

Each argument is described in detail in: Paws::GroundStation::ListContacts

Returns: a Paws::GroundStation::ListContactsResponse instance

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundstation, missionprofileArn, and satelliteArn.

ListDataflowEndpointGroups

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GroundStation::ListDataflowEndpointGroups

Returns: a Paws::GroundStation::ListDataflowEndpointGroupsResponse instance

Returns a list of DataflowEndpoint groups.

ListGroundStations

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GroundStation::ListGroundStations

Returns: a Paws::GroundStation::ListGroundStationsResponse instance

Returns a list of ground stations.

ListMissionProfiles

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GroundStation::ListMissionProfiles

Returns: a Paws::GroundStation::ListMissionProfilesResponse instance

Returns a list of mission profiles.

ListSatellites

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GroundStation::ListSatellites

Returns: a Paws::GroundStation::ListSatellitesResponse instance

Returns a list of satellites.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::GroundStation::ListTagsForResource

Returns: a Paws::GroundStation::ListTagsForResourceResponse instance

Returns a list of tags or a specified resource.

ReserveContact

EndTime => Str
GroundStation => Str
MissionProfileArn => Str
SatelliteArn => Str
StartTime => Str
[Tags => Paws::GroundStation::TagsMap]

Each argument is described in detail in: Paws::GroundStation::ReserveContact

Returns: a Paws::GroundStation::ContactIdResponse instance

Reserves a contact using specified parameters.

TagResource

ResourceArn => Str
[Tags => Paws::GroundStation::TagsMap]

Each argument is described in detail in: Paws::GroundStation::TagResource

Returns: a Paws::GroundStation::TagResourceResponse instance

Assigns a tag to a resource.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::GroundStation::UntagResource

Returns: a Paws::GroundStation::UntagResourceResponse instance

Deassigns a resource tag.

UpdateConfig

ConfigData => Paws::GroundStation::ConfigTypeData
ConfigId => Str
ConfigType => Str
Name => Str

Each argument is described in detail in: Paws::GroundStation::UpdateConfig

Returns: a Paws::GroundStation::ConfigIdResponse instance

Updates the Config used when scheduling contacts.

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

UpdateMissionProfile

MissionProfileId => Str
[ContactPostPassDurationSeconds => Int]
[ContactPrePassDurationSeconds => Int]
[DataflowEdges => ArrayRef[ArrayRef[Str|Undef]]]
[MinimumViableContactDurationSeconds => Int]
[Name => Str]
[TrackingConfigArn => Str]

Each argument is described in detail in: Paws::GroundStation::UpdateMissionProfile

Returns: a Paws::GroundStation::MissionProfileIdResponse instance

Updates a mission profile.

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllConfigs(sub { },[MaxResults => Int, NextToken => Str])

ListAllConfigs([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - configList, passing the object as the first parameter, and the string 'configList' as the second parameter 

If not, it will return a a Paws::GroundStation::ListConfigsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllContacts(sub { },EndTime => Str, StartTime => Str, StatusList => ArrayRef[Str|Undef], [GroundStation => Str, MaxResults => Int, MissionProfileArn => Str, NextToken => Str, SatelliteArn => Str])

ListAllContacts(EndTime => Str, StartTime => Str, StatusList => ArrayRef[Str|Undef], [GroundStation => Str, MaxResults => Int, MissionProfileArn => Str, NextToken => Str, SatelliteArn => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - contactList, passing the object as the first parameter, and the string 'contactList' as the second parameter 

If not, it will return a a Paws::GroundStation::ListContactsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDataflowEndpointGroups(sub { },[MaxResults => Int, NextToken => Str])

ListAllDataflowEndpointGroups([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - dataflowEndpointGroupList, passing the object as the first parameter, and the string 'dataflowEndpointGroupList' as the second parameter 

If not, it will return a a Paws::GroundStation::ListDataflowEndpointGroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllGroundStations(sub { },[MaxResults => Int, NextToken => Str])

ListAllGroundStations([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - groundStationList, passing the object as the first parameter, and the string 'groundStationList' as the second parameter 

If not, it will return a a Paws::GroundStation::ListGroundStationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllMissionProfiles(sub { },[MaxResults => Int, NextToken => Str])

ListAllMissionProfiles([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - missionProfileList, passing the object as the first parameter, and the string 'missionProfileList' as the second parameter 

If not, it will return a a Paws::GroundStation::ListMissionProfilesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSatellites(sub { },[MaxResults => Int, NextToken => Str])

ListAllSatellites([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - satellites, passing the object as the first parameter, and the string 'satellites' as the second parameter 

If not, it will return a a Paws::GroundStation::ListSatellitesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues