Skip to content

list_saml_providers

Operation

list_saml_providers

list_saml_providers(request: ListSAMLProvidersInput | ListSAMLProvidersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSAMLProvidersInputDict]) -> ListSAMLProvidersOutput

Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

Warning

This operation requires Signature Version 4.

Parameters:

Name Type Description Default
request ListSAMLProvidersInput | ListSAMLProvidersInputDict | 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[ListSAMLProvidersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListSAMLProvidersOutput

An instance of ListSAMLProvidersOutput.

list_saml_providers async

list_saml_providers(request: ListSAMLProvidersInput | ListSAMLProvidersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSAMLProvidersInputDict]) -> ListSAMLProvidersOutput

Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

Warning

This operation requires Signature Version 4.

Parameters:

Name Type Description Default
request ListSAMLProvidersInput | ListSAMLProvidersInputDict | 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[ListSAMLProvidersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListSAMLProvidersOutput

An instance of ListSAMLProvidersOutput.

Input

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

ListSAMLProvidersInputDict

Bases: TypedDict

Dictionary form of ListSAMLProvidersInput.

ListSAMLProvidersInput dataclass

Bases: _SerdeShape

Dataclass for ListSAMLProvidersInput structure.

Output

ListSAMLProvidersOutput dataclass

Bases: _SerdeShape

Contains the response to a successful ListSAMLProviders request.

Attributes

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.

saml_provider_list class-attribute instance-attribute
saml_provider_list: list[SAMLProviderListEntry] | None = ...

The list of SAML provider resource objects defined in IAM for this Amazon Web Services account.