Skip to content

get_outbound_web_identity_federation_info

Operation

get_outbound_web_identity_federation_info

Retrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.

Parameters:

Name Type Description Default
request GetOutboundWebIdentityFederationInfoInput | GetOutboundWebIdentityFederationInfoInputDict | 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[GetOutboundWebIdentityFederationInfoInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOutboundWebIdentityFederationInfoOutput

An instance of GetOutboundWebIdentityFederationInfoOutput.

get_outbound_web_identity_federation_info async

Retrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.

Parameters:

Name Type Description Default
request GetOutboundWebIdentityFederationInfoInput | GetOutboundWebIdentityFederationInfoInputDict | 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[GetOutboundWebIdentityFederationInfoInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOutboundWebIdentityFederationInfoOutput

An instance of GetOutboundWebIdentityFederationInfoOutput.

Input

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

GetOutboundWebIdentityFederationInfoInputDict

Bases: TypedDict

Dictionary form of GetOutboundWebIdentityFederationInfoInput.

GetOutboundWebIdentityFederationInfoInput dataclass

Bases: _SerdeShape

Dataclass for GetOutboundWebIdentityFederationInfoInput structure.

Output

GetOutboundWebIdentityFederationInfoOutput dataclass

Bases: _SerdeShape

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

jwt_vending_enabled class-attribute instance-attribute
jwt_vending_enabled: bool = ...

Indicates whether outbound identity federation is currently enabled for your Amazon Web Services account. When true, IAM principals in the account can call the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for authentication with external services.

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.