create_dataflow_endpoint_group¶

GroundStation.Client.create_dataflow_endpoint_group(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.create_dataflow_endpoint_group(
    contactPostPassDurationSeconds=123,
    contactPrePassDurationSeconds=123,
    endpointDetails=[
        {
            'awsGroundStationAgentEndpoint': {
                'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
                'auditResults': 'HEALTHY'|'UNHEALTHY',
                'egressAddress': {
                    'mtu': 123,
                    'socketAddress': {
                        'name': 'string',
                        'port': 123
                    }
                },
                'ingressAddress': {
                    'mtu': 123,
                    'socketAddress': {
                        'name': 'string',
                        'portRange': {
                            'maximum': 123,
                            'minimum': 123
                        }
                    }
                },
                'name': 'string'
            },
            'endpoint': {
                'address': {
                    'name': 'string',
                    'port': 123
                },
                'mtu': 123,
                'name': 'string',
                'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
            },
            'securityDetails': {
                'roleArn': 'string',
                'securityGroupIds': [
                    'string',
                ],
                'subnetIds': [
                    'string',
                ]
            }
        },
    ],
    tags={
        'string': 'string'
    }
)

Parameters

contactPostPassDurationSeconds (integer) -- Amount of time, in seconds, after a contact ends for the contact to remain in a POSTPASS state. A CloudWatch event is emitted when the contact enters and exits the POSTPASS state.
contactPrePassDurationSeconds (integer) -- Amount of time, in seconds, prior to contact start for the contact to remain in a PREPASS state. A CloudWatch event is emitted when the contact enters and exits the PREPASS state.
endpointDetails (list) --
[REQUIRED]

Endpoint details of each endpoint in the dataflow endpoint group.
- (dict) --
  Information about the endpoint details.
  - awsGroundStationAgentEndpoint (dict) --
    An agent endpoint.
    - agentStatus (string) --
      The status of AgentEndpoint.
    - auditResults (string) --
      The results of the audit.
    - egressAddress (dict) -- [REQUIRED]
      The egress address of AgentEndpoint.
      - mtu (integer) --
        Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
      - socketAddress (dict) -- [REQUIRED]
        A socket address.
        
        name (string) -- [REQUIRED]
        Name of a socket address.
        
        port (integer) -- [REQUIRED]
        Port of a socket address.
    - ingressAddress (dict) -- [REQUIRED]
      The ingress address of AgentEndpoint.
      - mtu (integer) --
        Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
      - socketAddress (dict) -- [REQUIRED]
        A ranged socket address.
        
        name (string) -- [REQUIRED]
        IPv4 socket address.
        
        portRange (dict) -- [REQUIRED]
        Port range of a socket address.
        
        maximum (integer) -- [REQUIRED]
        A maximum value.
        
        minimum (integer) -- [REQUIRED]
        A minimum value.
    - name (string) -- [REQUIRED]
      Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
  - endpoint (dict) --
    A dataflow endpoint.
    - address (dict) --
      Socket address of a dataflow endpoint.
      - 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.
    - name (string) --
      Name of a dataflow endpoint.
    - status (string) --
      Status of a dataflow endpoint.
  - securityDetails (dict) --
    Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
    - roleArn (string) -- [REQUIRED]
      ARN to a role needed for connecting streams to your instances.
    - securityGroupIds (list) -- [REQUIRED]
      The security groups to attach to the elastic network interfaces.
      - (string) --
    - subnetIds (list) -- [REQUIRED]
      A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
      - (string) --
tags (dict) --
Tags of a dataflow endpoint group.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'dataflowEndpointGroupId': 'string'
}

Response Structure

(dict) --
- dataflowEndpointGroupId (string) --
  
  UUID of a dataflow endpoint group.

Exceptions

GroundStation.Client.exceptions.InvalidParameterException
GroundStation.Client.exceptions.DependencyException
GroundStation.Client.exceptions.ResourceNotFoundException

Table Of Contents

create_dataflow_endpoint_group¶