Skip to content

get_resource_api_key

Operation

get_resource_api_key

get_resource_api_key(request: GetResourceApiKeyInput | GetResourceApiKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourceApiKeyInputDict]) -> GetResourceApiKeyOutput

Retrieves the API key associated with an API key credential provider.

Parameters:

Name Type Description Default
request GetResourceApiKeyInput | GetResourceApiKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetResourceApiKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourceApiKeyOutput

An instance of GetResourceApiKeyOutput.

get_resource_api_key async

get_resource_api_key(request: GetResourceApiKeyInput | GetResourceApiKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourceApiKeyInputDict]) -> GetResourceApiKeyOutput

Retrieves the API key associated with an API key credential provider.

Parameters:

Name Type Description Default
request GetResourceApiKeyInput | GetResourceApiKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetResourceApiKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourceApiKeyOutput

An instance of GetResourceApiKeyOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetResourceApiKeyInputDict

Bases: TypedDict

Dictionary form of GetResourceApiKeyInput.

Attributes

resource_credential_provider_name instance-attribute
resource_credential_provider_name: Required[str]

The credential provider name for the resource from which you are retrieving the API key.

workload_identity_token instance-attribute
workload_identity_token: Required[str]

The identity token of the workload from which you want to retrieve the API key.

GetResourceApiKeyInput dataclass

Bases: _SerdeShape

Dataclass for GetResourceApiKeyInput structure.

Attributes

resource_credential_provider_name class-attribute instance-attribute
resource_credential_provider_name: str | None = ...

The credential provider name for the resource from which you are retrieving the API key.

workload_identity_token class-attribute instance-attribute
workload_identity_token: str | None = ...

The identity token of the workload from which you want to retrieve the API key.

Output

GetResourceApiKeyOutput dataclass

Bases: _SerdeShape

Dataclass for GetResourceApiKeyOutput structure.

Attributes

api_key instance-attribute
api_key: str

The API key associated with the resource requested.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.