AWS API Changes

2023/10/25 - AWS Ground Station - 3 updated api methods

Changes This release will allow KMS alias names to be used when creating Mission Profiles

CreateMissionProfile (updated)

Link ¶
Changes (request)

{'streamsKmsKey': {'kmsAliasName': 'string'}}

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.

See also: AWS API Documentation

Request Syntax

client.create_mission_profile(
    contactPostPassDurationSeconds=123,
    contactPrePassDurationSeconds=123,
    dataflowEdges=[
        [
            'string',
        ],
    ],
    minimumViableContactDurationSeconds=123,
    name='string',
    streamsKmsKey={
        'kmsAliasArn': 'string',
        'kmsAliasName': 'string',
        'kmsKeyArn': 'string'
    },
    streamsKmsRole='string',
    tags={
        'string': 'string'
    },
    trackingConfigArn='string'
)

type contactPostPassDurationSeconds:

integer

param contactPostPassDurationSeconds:

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

type contactPrePassDurationSeconds:

integer

param contactPrePassDurationSeconds:

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

type dataflowEdges:

list

param dataflowEdges:

[REQUIRED]

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

(list) --
- (string) --

type minimumViableContactDurationSeconds:

integer

param minimumViableContactDurationSeconds:

[REQUIRED]

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.

type name:

string

param name:

[REQUIRED]

Name of a mission profile.

type streamsKmsKey:

dict

param streamsKmsKey:

KMS key to use for encrypting streams.

kmsAliasArn (string) --

KMS Alias Arn.
kmsAliasName (string) --

KMS Alias Name.
kmsKeyArn (string) --

KMS Key Arn.

type streamsKmsRole:

string

param streamsKmsRole:

Role to use for encrypting streams with KMS key.

type tags:

dict

param tags:

Tags assigned to a mission profile.

(string) --
- (string) --

type trackingConfigArn:

string

param trackingConfigArn:

[REQUIRED]

ARN of a tracking Config.

rtype:

dict

returns:

Response Syntax

{
    'missionProfileId': 'string'
}

Response Structure

(dict) --
- missionProfileId (string) --
  
  UUID of a mission profile.

GetMissionProfile (updated)

Link ¶
Changes (response)

{'streamsKmsKey': {'kmsAliasName': 'string'}}

Returns a mission profile.

See also: AWS API Documentation

Request Syntax

client.get_mission_profile(
    missionProfileId='string'
)

type missionProfileId:

string

param missionProfileId:

[REQUIRED]

UUID of a mission profile.

rtype:

dict

returns:

Response Syntax

{
    'contactPostPassDurationSeconds': 123,
    'contactPrePassDurationSeconds': 123,
    'dataflowEdges': [
        [
            'string',
        ],
    ],
    'minimumViableContactDurationSeconds': 123,
    'missionProfileArn': 'string',
    'missionProfileId': 'string',
    'name': 'string',
    'region': 'string',
    'streamsKmsKey': {
        'kmsAliasArn': 'string',
        'kmsAliasName': 'string',
        'kmsKeyArn': 'string'
    },
    'streamsKmsRole': 'string',
    'tags': {
        'string': 'string'
    },
    'trackingConfigArn': 'string'
}

Response Structure

(dict) --
- contactPostPassDurationSeconds (integer) --
  
  Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
- contactPrePassDurationSeconds (integer) --
  
  Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
- dataflowEdges (list) --
  
  A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
  - (list) --
    - (string) --
- minimumViableContactDurationSeconds (integer) --
  
  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.
- missionProfileArn (string) --
  
  ARN of a mission profile.
- missionProfileId (string) --
  
  UUID of a mission profile.
- name (string) --
  
  Name of a mission profile.
- region (string) --
  
  Region of a mission profile.
- streamsKmsKey (dict) --
  
  KMS key to use for encrypting streams.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: kmsAliasArn, kmsAliasName, kmsKeyArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - kmsAliasArn (string) --
    
    KMS Alias Arn.
  - kmsAliasName (string) --
    
    KMS Alias Name.
  - kmsKeyArn (string) --
    
    KMS Key Arn.
- streamsKmsRole (string) --
  
  Role to use for encrypting streams with KMS key.
- tags (dict) --
  
  Tags assigned to a mission profile.
  - (string) --
    - (string) --
- trackingConfigArn (string) --
  
  ARN of a tracking Config.

UpdateMissionProfile (updated)

Link ¶
Changes (request)

{'streamsKmsKey': {'kmsAliasName': 'string'}}

Updates a mission profile.

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

See also: AWS API Documentation

Request Syntax

client.update_mission_profile(
    contactPostPassDurationSeconds=123,
    contactPrePassDurationSeconds=123,
    dataflowEdges=[
        [
            'string',
        ],
    ],
    minimumViableContactDurationSeconds=123,
    missionProfileId='string',
    name='string',
    streamsKmsKey={
        'kmsAliasArn': 'string',
        'kmsAliasName': 'string',
        'kmsKeyArn': 'string'
    },
    streamsKmsRole='string',
    trackingConfigArn='string'
)

type contactPostPassDurationSeconds:

integer

param contactPostPassDurationSeconds:

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

type contactPrePassDurationSeconds:

integer

param contactPrePassDurationSeconds:

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

type dataflowEdges:

list

param dataflowEdges:

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

(list) --
- (string) --

type minimumViableContactDurationSeconds:

integer

param minimumViableContactDurationSeconds:

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.

type missionProfileId:

string

param missionProfileId:

[REQUIRED]

UUID of a mission profile.

type name:

string

param name:

Name of a mission profile.

type streamsKmsKey:

dict

param streamsKmsKey:

KMS key to use for encrypting streams.

kmsAliasArn (string) --

KMS Alias Arn.
kmsAliasName (string) --

KMS Alias Name.
kmsKeyArn (string) --

KMS Key Arn.

type streamsKmsRole:

string

param streamsKmsRole:

Role to use for encrypting streams with KMS key.

type trackingConfigArn:

string

param trackingConfigArn:

ARN of a tracking Config.

rtype:

dict

returns:

Response Syntax

{
    'missionProfileId': 'string'
}

Response Structure

(dict) --
- missionProfileId (string) --
  
  UUID of a mission profile.