get_saml_provider¶
Operation¶
get_saml_provider
async
¶
get_saml_provider(request: GetSAMLProviderInput | GetSAMLProviderInputDict, /, *, plugins: list[Plugin] | None = None) -> GetSAMLProviderOutput
get_saml_provider(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSAMLProviderInputDict]) -> GetSAMLProviderOutput
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
Note
This operation requires Signature Version 4.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
GetSAMLProviderOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
GetSAMLProviderInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetSAMLProviderInput structure.
Attributes¶
saml_provider_arn
class-attribute
instance-attribute
¶
saml_provider_arn: str | None = ...
The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Dictionaries¶
GetSAMLProviderInputDict
¶
Bases: TypedDict
Dictionary form of GetSAMLProviderInput.
Attributes¶
saml_provider_arn
instance-attribute
¶
The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Output¶
GetSAMLProviderOutput
dataclass
¶
Bases: _SerdeShape
Contains the response to a successful GetSAMLProvider request.
Attributes¶
assertion_encryption_mode
class-attribute
instance-attribute
¶
assertion_encryption_mode: str | None = ...
Specifies the encryption setting for the SAML provider.
create_date
class-attribute
instance-attribute
¶
create_date: datetime | None = ...
The date and time when the SAML provider was created.
private_key_list
class-attribute
instance-attribute
¶
private_key_list: list[SAMLPrivateKey] | None = ...
The private key metadata for the SAML provider.
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.
saml_metadata_document
class-attribute
instance-attribute
¶
saml_metadata_document: str | None = ...
The XML metadata document that includes information about an identity provider.
saml_provider_uuid
class-attribute
instance-attribute
¶
saml_provider_uuid: str | None = ...
The unique identifier assigned to the SAML provider.
tags
class-attribute
instance-attribute
¶
A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.