GroundStation / Client / get_mission_profile

get_mission_profile#

GroundStation.Client.get_mission_profile(**kwargs)#

Returns a mission profile.

See also: AWS API Documentation

Request Syntax

response = client.get_mission_profile(
    missionProfileId='string'
)
Parameters:

missionProfileId (string) –

[REQUIRED]

UUID of a mission profile.

Return type:

dict

Returns:

Response Syntax

{
    'contactPostPassDurationSeconds': 123,
    'contactPrePassDurationSeconds': 123,
    'dataflowEdges': [
        [
            'string',
        ],
    ],
    'minimumViableContactDurationSeconds': 123,
    'missionProfileArn': 'string',
    'missionProfileId': 'string',
    'name': 'string',
    'region': 'string',
    'streamsKmsKey': {
        'kmsAliasArn': '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, 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.

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

Exceptions

  • GroundStation.Client.exceptions.InvalidParameterException

  • GroundStation.Client.exceptions.DependencyException

  • GroundStation.Client.exceptions.ResourceNotFoundException