ManagedintegrationsforIoTDeviceManagement / Client / create_connector_destination

create_connector_destination

ManagedintegrationsforIoTDeviceManagement.Client.create_connector_destination(**kwargs)

Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer’s Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.create_connector_destination(
    Name='string',
    Description='string',
    CloudConnectorId='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'
    },
    ClientToken='string'
)
Parameters:

  • Name (string) – The display name of the connector destination.

  • Description (string) – A description of the connector destination.

  • CloudConnectorId (string) –

    [REQUIRED]

    The identifier of the C2C connector.

  • AuthType (string) –

    [REQUIRED]

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

  • AuthConfig (dict) –

    [REQUIRED]

    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) – [REQUIRED]

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

      • tokenUrl (string) – [REQUIRED]

        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) – [REQUIRED]

        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) –

    [REQUIRED]

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

    • arn (string) – [REQUIRED]

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

    • versionId (string) – [REQUIRED]

      The version ID of the AWS Secrets Manager secret.

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) –

    • Id (string) –

      The identifier of the C2C connector destination creation request.

Exceptions