Skip to content

get_workload_identity

Operation

get_workload_identity

get_workload_identity(request: GetWorkloadIdentityInput | GetWorkloadIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetWorkloadIdentityInputDict]) -> GetWorkloadIdentityOutput

Retrieves information about a workload identity.

Parameters:

Name Type Description Default
request GetWorkloadIdentityInput | GetWorkloadIdentityInputDict | 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[GetWorkloadIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetWorkloadIdentityOutput

An instance of GetWorkloadIdentityOutput.

get_workload_identity async

get_workload_identity(request: GetWorkloadIdentityInput | GetWorkloadIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetWorkloadIdentityInputDict]) -> GetWorkloadIdentityOutput

Retrieves information about a workload identity.

Parameters:

Name Type Description Default
request GetWorkloadIdentityInput | GetWorkloadIdentityInputDict | 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[GetWorkloadIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetWorkloadIdentityOutput

An instance of GetWorkloadIdentityOutput.

Input

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

GetWorkloadIdentityInputDict

Bases: TypedDict

Dictionary form of GetWorkloadIdentityInput.

Attributes

name instance-attribute
name: Required[str]

The name of the workload identity to retrieve.

GetWorkloadIdentityInput dataclass

Bases: _SerdeShape

Dataclass for GetWorkloadIdentityInput structure.

Attributes

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

The name of the workload identity to retrieve.

Output

GetWorkloadIdentityOutput dataclass

Bases: _SerdeShape

Dataclass for GetWorkloadIdentityOutput structure.

Attributes

allowed_resource_oauth2_return_urls class-attribute instance-attribute
allowed_resource_oauth2_return_urls: list[str] | None = ...

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

created_time instance-attribute
created_time: datetime

The timestamp when the workload identity was created.

last_updated_time instance-attribute
last_updated_time: datetime

The timestamp when the workload identity was last updated.

name instance-attribute
name: str

The name of the workload identity.

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.

workload_identity_arn instance-attribute
workload_identity_arn: str

The Amazon Resource Name (ARN) of the workload identity.