Skip to content

create_workload_identity

Operation

create_workload_identity

create_workload_identity(request: CreateWorkloadIdentityInput | CreateWorkloadIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateWorkloadIdentityInputDict]) -> CreateWorkloadIdentityOutput

Creates a new workload identity.

Parameters:

Name Type Description Default
request CreateWorkloadIdentityInput | CreateWorkloadIdentityInputDict | 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[CreateWorkloadIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateWorkloadIdentityOutput

An instance of CreateWorkloadIdentityOutput.

create_workload_identity async

create_workload_identity(request: CreateWorkloadIdentityInput | CreateWorkloadIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateWorkloadIdentityInputDict]) -> CreateWorkloadIdentityOutput

Creates a new workload identity.

Parameters:

Name Type Description Default
request CreateWorkloadIdentityInput | CreateWorkloadIdentityInputDict | 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[CreateWorkloadIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateWorkloadIdentityOutput

An instance of CreateWorkloadIdentityOutput.

Input

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

CreateWorkloadIdentityInputDict

Bases: TypedDict

Dictionary form of CreateWorkloadIdentityInput.

Attributes

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

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

name instance-attribute
name: Required[str]

The name of the workload identity. The name must be unique within your account.

tags instance-attribute
tags: Mapping[str, str] | None

A map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

CreateWorkloadIdentityInput dataclass

Bases: _SerdeShape

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

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

The name of the workload identity. The name must be unique within your account.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

A map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Output

CreateWorkloadIdentityOutput dataclass

Bases: _SerdeShape

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

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.