Class InstanceProfilesClient

Index

Constructors

Methods

addInstanceProfile editInstanceProfile listInstanceProfiles removeInstanceProfile

Constructors

constructor

new InstanceProfilesClient(options: ClientOptions): InstanceProfilesClient
Parameters
- options: ClientOptions
Returns InstanceProfilesClient
- Defined in client.ts:57

Methods

addInstanceProfile

addInstanceProfile(
req: AddInstanceProfileRequest,
options?: CallOptions,
): Promise<AddInstanceProfileResponse>
Registers an instance profile in . In the UI, you can then give users the permission to use this instance profile when launching clusters.

This API is only available to admin users.
Parameters
- req: AddInstanceProfileRequest
- Optionaloptions: CallOptions
Returns Promise<AddInstanceProfileResponse>
- Defined in client.ts:78

editInstanceProfile

editInstanceProfile(
req: EditInstanceProfileRequest,
options?: CallOptions,
): Promise<EditInstanceProfileResponse>
The only supported field to change is the optional IAM role ARN associated with the instance profile. It is required to specify the IAM role ARN if both of the following are true:
- Your role name and instance profile name do not match. The name is the part after the last slash in each ARN.
- You want to use the instance profile with Databricks SQL Serverless.
To understand where these fields are in the AWS console, see Enable serverless SQL warehouses.

This API is only available to admin users.
Parameters
- req: EditInstanceProfileRequest
- Optionaloptions: CallOptions
Returns Promise<EditInstanceProfileResponse>
- Defined in client.ts:121

listInstanceProfiles

listInstanceProfiles(
_req: ListInstanceProfilesRequest,
options?: CallOptions,
): Promise<ListInstanceProfilesResponse>
List the instance profiles that the calling user can use to launch a cluster.

This API is available to all users.
Parameters
- _req: ListInstanceProfilesRequest
- Optionaloptions: CallOptions
Returns Promise<ListInstanceProfilesResponse>
- Defined in client.ts:158

removeInstanceProfile

removeInstanceProfile(
req: RemoveInstanceProfileRequest,
options?: CallOptions,
): Promise<RemoveInstanceProfileResponse>
Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function.

This API is only accessible to admin users.
Parameters
- req: RemoveInstanceProfileRequest
- Optionaloptions: CallOptions
Returns Promise<RemoveInstanceProfileResponse>
- Defined in client.ts:195