ManagedintegrationsforIoTDeviceManagement / Client / get_cloud_connector

get_cloud_connector

ManagedintegrationsforIoTDeviceManagement.Client.get_cloud_connector(**kwargs)

Gets all the information about a connector for a connector developer.

See also: AWS API Documentation

Request Syntax

response = client.get_cloud_connector(
    Identifier='string'
)
Parameters:

Identifier (string) –

[REQUIRED]

The identifier of the C2C connector.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'EndpointConfig': {
        'lambda': {
            'arn': 'string'
        }
    },
    'Description': 'string',
    'EndpointType': 'LAMBDA',
    'Id': 'string',
    'Type': 'LISTED'|'UNLISTED'
}

Response Structure

  • (dict) –

    • Name (string) –

      The display name of the C2C connector.

    • EndpointConfig (dict) –

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

      • lambda (dict) –

        The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function.

        • arn (string) –

          The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.

    • Description (string) –

      A description of the C2C connector.

    • EndpointType (string) –

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

    • Id (string) –

      The unique identifier of the cloud connector.

    • Type (string) –

      The type of cloud connector created.

Exceptions