ManagedintegrationsforIoTDeviceManagement / Client / get_connector_destination

get_connector_destination

ManagedintegrationsforIoTDeviceManagement.Client.get_connector_destination(**kwargs)

Get a connector destination of a cloud-to-cloud (C2C) connector connecting to a customer’s Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

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

Identifier (string) –

[REQUIRED]

The identifier of the C2C connector destination.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'CloudConnectorId': 'string',
    'Id': 'string',
    'AuthType': 'OAUTH',
    'AuthConfig': {
        'oAuth': {
            'authUrl': 'string',
            'tokenUrl': 'string',
            'scope': 'string',
            'tokenEndpointAuthenticationScheme': 'HTTP_BASIC'|'REQUEST_BODY_CREDENTIALS',
            'oAuthCompleteRedirectUrl': 'string',
            'proactiveRefreshTokenRenewal': {
                'enabled': True|False,
                'DaysBeforeRenewal': 123
            }
        }
    },
    'SecretsManager': {
        'arn': 'string',
        'versionId': 'string'
    },
    'OAuthCompleteRedirectUrl': 'string'
}

Response Structure

  • (dict) –

    • Name (string) –

      The display name of the connector destination.

    • Description (string) –

      A description of the connector destination.

    • CloudConnectorId (string) –

      The identifier of the C2C connector.

    • Id (string) –

      The unique identifier of the connector destination.

    • AuthType (string) –

      The authentication type used for the connector destination, which determines how credentials and access are managed.

    • AuthConfig (dict) –

      The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.

      • oAuth (dict) –

        The OAuth configuration settings used for authentication with the third-party service.

        • authUrl (string) –

          The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

        • tokenUrl (string) –

          The token URL for the OAuth service, where authorization codes are exchanged for access tokens.

        • scope (string) –

          The OAuth scopes requested during authorization, which define the permissions granted to the application.

        • tokenEndpointAuthenticationScheme (string) –

          The authentication scheme used when requesting tokens from the token endpoint.

        • oAuthCompleteRedirectUrl (string) –

          The URL where users are redirected after completing the OAuth authorization process.

        • proactiveRefreshTokenRenewal (dict) –

          Configuration for proactively refreshing OAuth tokens before they expire.

          • enabled (boolean) –

            Indicates whether proactive refresh token renewal is enabled.

          • DaysBeforeRenewal (integer) –

            The days before token expiration when the system should attempt to renew the token, specified in days.

    • SecretsManager (dict) –

      The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.

      • arn (string) –

        The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.

      • versionId (string) –

        The version ID of the AWS Secrets Manager secret.

    • OAuthCompleteRedirectUrl (string) –

      The URL where users are redirected after completing the OAuth authorization process for the connector destination.

Exceptions