AWS API Changes

2023/01/19 - AWS Ground Station - 2 updated api methods

Changes Add configurable prepass and postpass times for DataflowEndpointGroup. Add Waiter to allow customers to wait for a contact that was reserved through ReserveContact

CreateDataflowEndpointGroup (updated)

Link ¶
Changes (request)

{'contactPostPassDurationSeconds': 'integer',
 'contactPrePassDurationSeconds': 'integer'}

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

client.create_dataflow_endpoint_group(
    contactPostPassDurationSeconds=123,
    contactPrePassDurationSeconds=123,
    endpointDetails=[
        {
            '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'
    }
)

type contactPostPassDurationSeconds:

integer

param contactPostPassDurationSeconds:

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.

type contactPrePassDurationSeconds:

integer

param contactPrePassDurationSeconds:

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.

type endpointDetails:

list

param endpointDetails:

[REQUIRED]

Endpoint details of each endpoint in the dataflow endpoint group.

(dict) --

Information about the endpoint details.
- 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) --

type tags:

dict

param tags:

Tags of a dataflow endpoint group.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'dataflowEndpointGroupId': 'string'
}

Response Structure

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

GetDataflowEndpointGroup (updated)

Link ¶
Changes (response)

{'contactPostPassDurationSeconds': 'integer',
 'contactPrePassDurationSeconds': 'integer'}

Returns the dataflow endpoint group.

See also: AWS API Documentation

Request Syntax

client.get_dataflow_endpoint_group(
    dataflowEndpointGroupId='string'
)

type dataflowEndpointGroupId:

string

param dataflowEndpointGroupId:

[REQUIRED]

UUID of a dataflow endpoint group.

rtype:

dict

returns:

Response Syntax

{
    'contactPostPassDurationSeconds': 123,
    'contactPrePassDurationSeconds': 123,
    'dataflowEndpointGroupArn': 'string',
    'dataflowEndpointGroupId': 'string',
    'endpointsDetails': [
        {
            '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'
    }
}

Response Structure

(dict) --
- 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.
- dataflowEndpointGroupArn (string) --
  
  ARN of a dataflow endpoint group.
- dataflowEndpointGroupId (string) --
  
  UUID of a dataflow endpoint group.
- endpointsDetails (list) --
  
  Details of a dataflow endpoint.
  - (dict) --
    
    Information about the endpoint details.
    - endpoint (dict) --
      
      A dataflow endpoint.
      - address (dict) --
        
        Socket address of a dataflow endpoint.
        
        name (string) --
        
        Name of a socket address.
        
        port (integer) --
        
        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) --
        
        ARN to a role needed for connecting streams to your instances.
      - securityGroupIds (list) --
        
        The security groups to attach to the elastic network interfaces.
        
        (string) --
      - subnetIds (list) --
        
        A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
        
        (string) --
- tags (dict) --
  
  Tags assigned to a dataflow endpoint group.
  - (string) --
    - (string) --