Skip to content

create_cloud_connector

create_cloud_connector(
    name: DisplayName,
    endpoint_config: EndpointConfig,
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    description: Optional[CloudConnectorDescription] = None,
    endpoint_type: Optional[EndpointType] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateCloudConnectorResponse

Creates a C2C (cloud-to-cloud) connector.

Parameters:

  • name (DisplayName) –

    The display name of the C2C connector.

  • endpoint_config (EndpointConfig) –

    The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.

  • description (Optional[CloudConnectorDescription], default: None ) –

    A description of the C2C connector.

  • endpoint_type (Optional[EndpointType], default: None ) –

    The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.

  • client_token (Optional[ClientToken], default: None ) –

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

Raises:

Examples:

CreateCloudConnector happy path for TP Link

>>> client.create_cloud_connector(name='Connector for TP Link Cloud', endpoint_type='LAMBDA', endpoint_config={'lambda': {'arn': 'arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion'}}, client_token='1234567890')
CreateCloudConnector happy path for Ring
>>> client.create_cloud_connector(name='Connector for Ring Cloud', endpoint_type='LAMBDA', endpoint_config={'lambda': {'arn': 'arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion'}}, client_token='12312321')
CreateCloudConnector error path for Ring connector which already exists
>>> client.create_cloud_connector(name='Connector for Ring Cloud', endpoint_type='LAMBDA', endpoint_config={'lambda': {'arn': 'arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion2'}}, client_token='1213123123')
Source code in docs_src/capo_iot_managed_integrations/_services/io_t_managed_integrations.py
def create_cloud_connector(
    self,
    name: "capo_iot_managed_integrations.types.display_name.DisplayName",
    endpoint_config: "capo_iot_managed_integrations.types.endpoint_config.EndpointConfig",
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    description: Optional[
        "capo_iot_managed_integrations.types.cloud_connector_description.CloudConnectorDescription"
    ] = None,
    endpoint_type: Optional[
        "capo_iot_managed_integrations.types.endpoint_type.EndpointType"
    ] = None,
    client_token: Optional[
        "capo_iot_managed_integrations.types.client_token.ClientToken"
    ] = None,
) -> "capo_iot_managed_integrations.types.create_cloud_connector_response.CreateCloudConnectorResponse":
    """<p>Creates a C2C (cloud-to-cloud) connector.</p>

    Args:
        name: <p>The display name of the C2C connector.</p>
        endpoint_config: <p>The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.</p>
        description: <p>A description of the C2C connector.</p>
        endpoint_type: <p>The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.</p>
        client_token: <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>

    Raises:
        capo_iot_managed_integrations.errors.access_denied_exception.AccessDeniedException: <p>User is not authorized.</p>
        capo_iot_managed_integrations.errors.conflict_exception.ConflictException: <p>There is a conflict with the request.</p>
        capo_iot_managed_integrations.errors.internal_server_exception.InternalServerException: <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
        capo_iot_managed_integrations.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot_managed_integrations.errors.validation_exception.ValidationException: <p>A validation error occurred when performing the API request.</p>
        capo_iot_managed_integrations.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        CreateCloudConnector happy path for TP Link

        >>> client.create_cloud_connector(name='Connector for TP Link Cloud', endpoint_type='LAMBDA', endpoint_config={'lambda': {'arn': 'arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion'}}, client_token='1234567890')
        CreateCloudConnector happy path for Ring

        >>> client.create_cloud_connector(name='Connector for Ring Cloud', endpoint_type='LAMBDA', endpoint_config={'lambda': {'arn': 'arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion'}}, client_token='12312321')
        CreateCloudConnector error path for Ring connector which already exists

        >>> client.create_cloud_connector(name='Connector for Ring Cloud', endpoint_type='LAMBDA', endpoint_config={'lambda': {'arn': 'arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion2'}}, client_token='1213123123')
    """

    def _handler(
        req: "OperationRequest[capo_iot_managed_integrations.types.create_cloud_connector_request.CreateCloudConnectorRequest]",
    ) -> OperationResponse[
        "capo_iot_managed_integrations.types.create_cloud_connector_response.CreateCloudConnectorResponse"
    ]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.create_cloud_connector

        output, http_response = (
            capo_iot_managed_integrations._operations.iot_managed_integrations.create_cloud_connector.create_cloud_connector(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCloudConnector")
    )
    input_: capo_iot_managed_integrations.types.create_cloud_connector_request.CreateCloudConnectorRequest = {
        "name": name,
        "endpoint_config": endpoint_config,
    }
    if description is not None:
        input_["description"] = description
    if endpoint_type is not None:
        input_["endpoint_type"] = endpoint_type
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output