aws_sdk_cognitoidentityprovider/client/
get_identity_provider_by_identifier.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetIdentityProviderByIdentifier`](crate::operation::get_identity_provider_by_identifier::builders::GetIdentityProviderByIdentifierFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::get_identity_provider_by_identifier::builders::GetIdentityProviderByIdentifierFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::get_identity_provider_by_identifier::builders::GetIdentityProviderByIdentifierFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to get information about the IdP.</p><br>
7    ///   - [`idp_identifier(impl Into<String>)`](crate::operation::get_identity_provider_by_identifier::builders::GetIdentityProviderByIdentifierFluentBuilder::idp_identifier) / [`set_idp_identifier(Option<String>)`](crate::operation::get_identity_provider_by_identifier::builders::GetIdentityProviderByIdentifierFluentBuilder::set_idp_identifier):<br>required: **true**<br><p>The identifier that you assigned to your user pool. The identifier is an alternative name for an IdP that is distinct from the IdP name. For example, an IdP with a name of <code>MyIdP</code> might have an identifier of the email domain <code>example.com</code>.</p><br>
8    /// - On success, responds with [`GetIdentityProviderByIdentifierOutput`](crate::operation::get_identity_provider_by_identifier::GetIdentityProviderByIdentifierOutput) with field(s):
9    ///   - [`identity_provider(Option<IdentityProviderType>)`](crate::operation::get_identity_provider_by_identifier::GetIdentityProviderByIdentifierOutput::identity_provider): <p>The configuration of the IdP in your user pool. Includes additional identifiers, the IdP name and type, and trust-relationship details like the issuer URL.</p>
10    /// - On failure, responds with [`SdkError<GetIdentityProviderByIdentifierError>`](crate::operation::get_identity_provider_by_identifier::GetIdentityProviderByIdentifierError)
11    pub fn get_identity_provider_by_identifier(
12        &self,
13    ) -> crate::operation::get_identity_provider_by_identifier::builders::GetIdentityProviderByIdentifierFluentBuilder {
14        crate::operation::get_identity_provider_by_identifier::builders::GetIdentityProviderByIdentifierFluentBuilder::new(self.handle.clone())
15    }
16}