Skip to main content
alter_credential(credential_name=None, credential_updates_map=None, options=None)[source]

Alter the properties of an existing credential.

Parameters

credential_name (str) –

Name of the credential to be altered. Must be an existing credential.

credential_updates_map (dict of str to str) –

Map containing the properties of the credential to be updated. Error if empty. Allowed keys are:

  • type – New type for the credential. Allowed values are:

    • aws_access_key

    • aws_iam_role

    • azure_ad

    • azure_oauth

    • azure_sas

    • azure_storage_key

    • docker

    • gcs_service_account_id

    • gcs_service_account_keys

    • hdfs

    • kafka

  • identity – New user for the credential.

  • secret – New password for the credential.

  • schema_name – Updates the schema name. If schema_name doesn’t exist, an error will be thrown. If schema_name is empty, then the user’s default schema will be used.

options (dict of str to str) –

Optional parameters.

Returns

A dict with the following entries–

credential_name (str) –

Value of input parameter credential_name.

info (dict of str to str) –

Additional information.