Skip to content

create_dataflow_endpoint_group async

create_dataflow_endpoint_group(
    endpoint_details: EndpointDetailsList,
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    tags: Optional[TagsMap] = None,
    contact_pre_pass_duration_seconds: Optional[
        DataflowEndpointGroupDurationInSeconds
    ] = None,
    contact_post_pass_duration_seconds: Optional[
        DataflowEndpointGroupDurationInSeconds
    ] = None,
) -> DataflowEndpointGroupIdResponse

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.

Parameters:

Raises:

Source code in docs_src/capo_groundstation/_services/async_ground_station.py
async def create_dataflow_endpoint_group(
    self,
    endpoint_details: "capo_groundstation.types.endpoint_details_list.EndpointDetailsList",
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    tags: Optional["capo_groundstation.types.tags_map.TagsMap"] = None,
    contact_pre_pass_duration_seconds: Optional[
        "capo_groundstation.types.dataflow_endpoint_group_duration_in_seconds.DataflowEndpointGroupDurationInSeconds"
    ] = None,
    contact_post_pass_duration_seconds: Optional[
        "capo_groundstation.types.dataflow_endpoint_group_duration_in_seconds.DataflowEndpointGroupDurationInSeconds"
    ] = None,
) -> "capo_groundstation.types.dataflow_endpoint_group_id_response.DataflowEndpointGroupIdResponse":
    """<p>Creates a <code>DataflowEndpoint</code> group containing the specified list of <code> DataflowEndpoint</code> objects.</p> <p>The <code>name</code> field in each endpoint is used in your mission profile <code> DataflowEndpointConfig</code> to specify which endpoints to use during a contact.</p> <p>When a contact uses multiple <code>DataflowEndpointConfig</code> objects, each <code> Config</code> must match a <code>DataflowEndpoint</code> in the same group.</p>

    Args:
        endpoint_details: <p>Endpoint details of each endpoint in the dataflow endpoint group. All dataflow endpoints within a single dataflow endpoint group must be of the same type. You cannot mix <a href="https://docs.aws.amazon.com/ground-station/latest/APIReference/API_AwsGroundStationAgentEndpoint.html"> AWS Ground Station Agent endpoints</a> with <a href="https://docs.aws.amazon.com/ground-station/latest/APIReference/API_DataflowEndpoint.html">Dataflow endpoints</a> in the same group. If your use case requires both types of endpoints, you must create separate dataflow endpoint groups for each type. </p>
        tags: <p>Tags of a dataflow endpoint group.</p>
        contact_pre_pass_duration_seconds: <p> Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a <code>PREPASS</code> state. A <a href="https://docs.aws.amazon.com/ground-station/latest/ug/monitoring.automating-events.html">Ground Station Dataflow Endpoint Group State Change event</a> will be emitted when the Dataflow Endpoint Group enters and exits the <code>PREPASS</code> state. </p>
        contact_post_pass_duration_seconds: <p> Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a <code>POSTPASS</code> state. A <a href="https://docs.aws.amazon.com/ground-station/latest/ug/monitoring.automating-events.html">Ground Station Dataflow Endpoint Group State Change event</a> will be emitted when the Dataflow Endpoint Group enters and exits the <code>POSTPASS</code> state. </p>

    Raises:
        capo_groundstation.errors.dependency_exception.DependencyException: <p>Dependency encountered an error.</p>
        capo_groundstation.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_groundstation.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource was not found.</p>
        capo_groundstation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_groundstation.types.create_dataflow_endpoint_group_request.CreateDataflowEndpointGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_groundstation.types.dataflow_endpoint_group_id_response.DataflowEndpointGroupIdResponse"
    ]:
        import capo_groundstation._operations.ground_station.create_dataflow_endpoint_group

        (
            output,
            http_response,
        ) = await capo_groundstation._operations.ground_station.create_dataflow_endpoint_group.async_create_dataflow_endpoint_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDataflowEndpointGroup")
    )
    input_: capo_groundstation.types.create_dataflow_endpoint_group_request.CreateDataflowEndpointGroupRequest = {
        "endpoint_details": endpoint_details
    }
    if tags is not None:
        input_["tags"] = tags
    if contact_pre_pass_duration_seconds is not None:
        input_["contact_pre_pass_duration_seconds"] = (
            contact_pre_pass_duration_seconds
        )
    if contact_post_pass_duration_seconds is not None:
        input_["contact_post_pass_duration_seconds"] = (
            contact_post_pass_duration_seconds
        )

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output