enable_outbound_web_identity_federation¶
Operation¶
enable_outbound_web_identity_federation
¶
enable_outbound_web_identity_federation(request: EnableOutboundWebIdentityFederationInput | EnableOutboundWebIdentityFederationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableOutboundWebIdentityFederationInputDict]) -> EnableOutboundWebIdentityFederationOutput
Enables the outbound identity federation feature for your Amazon Web
Services account. When enabled, IAM principals in your account can use
the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for
secure authentication with external services. This operation also
generates a unique issuer URL for your Amazon Web Services account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableOutboundWebIdentityFederationInput | EnableOutboundWebIdentityFederationInputDict | 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[EnableOutboundWebIdentityFederationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableOutboundWebIdentityFederationOutput
|
An instance of |
enable_outbound_web_identity_federation
async
¶
enable_outbound_web_identity_federation(request: EnableOutboundWebIdentityFederationInput | EnableOutboundWebIdentityFederationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableOutboundWebIdentityFederationInputDict]) -> EnableOutboundWebIdentityFederationOutput
Enables the outbound identity federation feature for your Amazon Web
Services account. When enabled, IAM principals in your account can use
the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for
secure authentication with external services. This operation also
generates a unique issuer URL for your Amazon Web Services account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableOutboundWebIdentityFederationInput | EnableOutboundWebIdentityFederationInputDict | 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[EnableOutboundWebIdentityFederationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableOutboundWebIdentityFederationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
EnableOutboundWebIdentityFederationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for EnableOutboundWebIdentityFederationOutput structure.
Attributes¶
issuer_identifier
class-attribute
instance-attribute
¶
issuer_identifier: str | None = ...
A unique issuer URL for your Amazon Web Services account that hosts the
OpenID Connect (OIDC) discovery endpoints at
/.well-known/openid-configuration and /.well-known/jwks.json. The
OpenID Connect (OIDC) discovery endpoints contain verification keys and
metadata necessary for token verification.
response_metadata
class-attribute
instance-attribute
¶
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.