Skip to content

update_workload_identity

Operation

update_workload_identity

update_workload_identity(request: UpdateWorkloadIdentityInput | UpdateWorkloadIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateWorkloadIdentityInputDict]) -> UpdateWorkloadIdentityOutput

Updates an existing workload identity.

Parameters:

Name Type Description Default
request UpdateWorkloadIdentityInput | UpdateWorkloadIdentityInputDict | 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[UpdateWorkloadIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateWorkloadIdentityOutput

An instance of UpdateWorkloadIdentityOutput.

update_workload_identity async

update_workload_identity(request: UpdateWorkloadIdentityInput | UpdateWorkloadIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateWorkloadIdentityInputDict]) -> UpdateWorkloadIdentityOutput

Updates an existing workload identity.

Parameters:

Name Type Description Default
request UpdateWorkloadIdentityInput | UpdateWorkloadIdentityInputDict | 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[UpdateWorkloadIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateWorkloadIdentityOutput

An instance of UpdateWorkloadIdentityOutput.

Input

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

UpdateWorkloadIdentityInputDict

Bases: TypedDict

Dictionary form of UpdateWorkloadIdentityInput.

Attributes

allowed_resource_oauth2_return_urls instance-attribute
allowed_resource_oauth2_return_urls: Sequence[str] | None

The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.

name instance-attribute
name: Required[str]

The name of the workload identity to update.

UpdateWorkloadIdentityInput dataclass

Bases: _SerdeShape

Dataclass for UpdateWorkloadIdentityInput structure.

Attributes

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

The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.

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

The name of the workload identity to update.

Output

UpdateWorkloadIdentityOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateWorkloadIdentityOutput 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.