ManagedintegrationsforIoTDeviceManagement / Client / update_connector_destination

update_connector_destination

ManagedintegrationsforIoTDeviceManagement.Client.update_connector_destination(**kwargs)

Updates the properties of an existing connector destination.

See also: AWS API Documentation

Request Syntax

response = client.update_connector_destination(
    Identifier='string',
    Description='string',
    Name='string',
    AuthType='OAUTH',
    AuthConfig={
        'oAuthUpdate': {
            'oAuthCompleteRedirectUrl': 'string',
            'proactiveRefreshTokenRenewal': {
                'enabled': True|False,
                'DaysBeforeRenewal': 123
            }
        },
        'GeneralAuthorizationUpdate': {
            'AuthMaterialsToAdd': [
                {
                    'SecretsManager': {
                        'arn': 'string',
                        'versionId': 'string'
                    },
                    'AuthMaterialName': 'string'
                },
            ],
            'AuthMaterialsToUpdate': [
                {
                    'SecretsManager': {
                        'arn': 'string',
                        'versionId': 'string'
                    },
                    'AuthMaterialName': 'string'
                },
            ]
        }
    },
    SecretsManager={
        'arn': 'string',
        'versionId': 'string'
    }
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    The unique identifier of the connector destination to update.

  • Description (string) – The new description to assign to the connector destination.

  • Name (string) – The new display name to assign to the connector destination.

  • AuthType (string) – The new authentication type to use for the connector destination.

  • AuthConfig (dict) –

    The updated authentication configuration details for the connector destination.

    • oAuthUpdate (dict) –

      The updated OAuth configuration settings for the authentication configuration.

      • oAuthCompleteRedirectUrl (string) –

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

      • proactiveRefreshTokenRenewal (dict) –

        Updated 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.

    • GeneralAuthorizationUpdate (dict) –

      The General Authorization update information containing authorization materials to add or update in Kinesis Data Streams.

      • AuthMaterialsToAdd (list) –

        The authorization materials to add.

        • (dict) –

          The authorization material containing the Secrets Manager arn and version.

          • SecretsManager (dict) – [REQUIRED]

            Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.

            • 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.

          • AuthMaterialName (string) – [REQUIRED]

            The name of the authorization material.

      • AuthMaterialsToUpdate (list) –

        The authorization materials to update.

        • (dict) –

          The authorization material containing the Secrets Manager arn and version.

          • SecretsManager (dict) – [REQUIRED]

            Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.

            • 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.

          • AuthMaterialName (string) – [REQUIRED]

            The name of the authorization material.

  • SecretsManager (dict) –

    The updated AWS Secrets Manager configuration 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.

Returns:

None

Exceptions