GroundStation / Client / create_dataflow_endpoint_group_v2

create_dataflow_endpoint_group_v2

GroundStation.Client.create_dataflow_endpoint_group_v2(**kwargs)

Creates a DataflowEndpointGroupV2 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.

See also: AWS API Documentation

Request Syntax

response = client.create_dataflow_endpoint_group_v2(
    endpoints=[
        {
            'uplinkAwsGroundStationAgentEndpoint': {
                'name': 'string',
                'dataflowDetails': {
                    'agentConnectionDetails': {
                        'ingressAddressAndPort': {
                            'socketAddress': {
                                'name': 'string',
                                'port': 123
                            },
                            'mtu': 123
                        },
                        'agentIpAndPortAddress': {
                            'socketAddress': {
                                'name': 'string',
                                'portRange': {
                                    'minimum': 123,
                                    'maximum': 123
                                }
                            },
                            'mtu': 123
                        }
                    }
                }
            },
            'downlinkAwsGroundStationAgentEndpoint': {
                'name': 'string',
                'dataflowDetails': {
                    'agentConnectionDetails': {
                        'agentIpAndPortAddress': {
                            'socketAddress': {
                                'name': 'string',
                                'portRange': {
                                    'minimum': 123,
                                    'maximum': 123
                                }
                            },
                            'mtu': 123
                        },
                        'egressAddressAndPort': {
                            'socketAddress': {
                                'name': 'string',
                                'port': 123
                            },
                            'mtu': 123
                        }
                    }
                }
            }
        },
    ],
    contactPrePassDurationSeconds=123,
    contactPostPassDurationSeconds=123,
    tags={
        'string': 'string'
    }
)

Parameters:

• endpoints (list) –

  [REQUIRED]

  Dataflow endpoint group’s endpoint definitions

  • (dict) –

    Endpoint definition used for creating a dataflow endpoint

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: uplinkAwsGroundStationAgentEndpoint, downlinkAwsGroundStationAgentEndpoint.

    • uplinkAwsGroundStationAgentEndpoint (dict) –

      Definition for an uplink agent endpoint

      • name (string) – [REQUIRED]

        Uplink dataflow endpoint name

      • dataflowDetails (dict) – [REQUIRED]

        Dataflow details for the uplink endpoint

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

        • agentConnectionDetails (dict) –

          Uplink connection details for customer to Agent and Agent to Ground Station

          • ingressAddressAndPort (dict) – [REQUIRED]

            Egress address of AgentEndpoint with an optional mtu.

            • socketAddress (dict) – [REQUIRED]

              A socket address.

              • name (string) – [REQUIRED]

                Name of a socket address.

              • port (integer) – [REQUIRED]

                Port of a socket address.

            • mtu (integer) –

              Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

          • agentIpAndPortAddress (dict) – [REQUIRED]

            Ingress address of AgentEndpoint with a port range and an optional mtu.

            • socketAddress (dict) – [REQUIRED]

              A ranged socket address.

              • name (string) – [REQUIRED]

                IPv4 socket address.

              • portRange (dict) – [REQUIRED]

                Port range of a socket address.

                • minimum (integer) – [REQUIRED]

                  A minimum value.

                • maximum (integer) – [REQUIRED]

                  A maximum value.

            • mtu (integer) –

              Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

    • downlinkAwsGroundStationAgentEndpoint (dict) –

      Definition for a downlink agent endpoint

      • name (string) – [REQUIRED]

        Downlink dataflow endpoint name

      • dataflowDetails (dict) – [REQUIRED]

        Dataflow details for the downlink endpoint

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

        • agentConnectionDetails (dict) –

          Downlink connection details for customer to Agent and Agent to Ground Station

          • agentIpAndPortAddress (dict) – [REQUIRED]

            Ingress address of AgentEndpoint with a port range and an optional mtu.

            • socketAddress (dict) – [REQUIRED]

              A ranged socket address.

              • name (string) – [REQUIRED]

                IPv4 socket address.

              • portRange (dict) – [REQUIRED]

                Port range of a socket address.

                • minimum (integer) – [REQUIRED]

                  A minimum value.

                • maximum (integer) – [REQUIRED]

                  A maximum value.

            • mtu (integer) –

              Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

          • egressAddressAndPort (dict) – [REQUIRED]

            Egress address of AgentEndpoint with an optional mtu.

            • socketAddress (dict) – [REQUIRED]

              A socket address.

              • name (string) – [REQUIRED]

                Name of a socket address.

              • port (integer) – [REQUIRED]

                Port of a socket address.

            • mtu (integer) –

              Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

• contactPrePassDurationSeconds (integer) – 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.

• contactPostPassDurationSeconds (integer) – 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.

• tags (dict) –

  Tags of a V2 dataflow endpoint group.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'dataflowEndpointGroupId': 'string'
}

Response Structure

• (dict) –

  • dataflowEndpointGroupId (string) –

    Dataflow endpoint group ID

Exceptions

• GroundStation.Client.exceptions.InvalidParameterException

• GroundStation.Client.exceptions.ServiceQuotaExceededException

• GroundStation.Client.exceptions.DependencyException

• GroundStation.Client.exceptions.ResourceNotFoundException