Package software.amazon.awssdk.services.cognitoidentity.model

Class DescribeIdentityPoolResponse

    • Method Detail

      • identityPoolId

        public final String identityPoolId()

        An identity pool ID in the format REGION:GUID.

        Returns:
        An identity pool ID in the format REGION:GUID.

      • identityPoolName

        public final String identityPoolName()

        A string that you provide.

        Returns:
        A string that you provide.

      • allowUnauthenticatedIdentities

        public final Boolean allowUnauthenticatedIdentities()

        TRUE if the identity pool supports unauthenticated logins.

        Returns:
        TRUE if the identity pool supports unauthenticated logins.

      • hasSupportedLoginProviders

        public final boolean hasSupportedLoginProviders()
        For responses, this returns true if the service returned a value for the SupportedLoginProviders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • supportedLoginProviders

        public final Map<String,​String> supportedLoginProviders()

        Optional key:value pairs mapping provider names to provider app IDs.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedLoginProviders() method.

        Returns:
        Optional key:value pairs mapping provider names to provider app IDs.

      • developerProviderName

        public final String developerProviderName()

        The "domain" by which Cognito will refer to your users.

        Returns:
        The "domain" by which Cognito will refer to your users.

      • hasOpenIdConnectProviderARNs

        public final boolean hasOpenIdConnectProviderARNs()
        For responses, this returns true if the service returned a value for the OpenIdConnectProviderARNs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • openIdConnectProviderARNs

        public final List<String> openIdConnectProviderARNs()

        The ARNs of the OpenID Connect providers.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOpenIdConnectProviderARNs() method.

        Returns:
        The ARNs of the OpenID Connect providers.

      • hasCognitoIdentityProviders

        public final boolean hasCognitoIdentityProviders()
        For responses, this returns true if the service returned a value for the CognitoIdentityProviders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • cognitoIdentityProviders

        public final List<CognitoIdentityProvider> cognitoIdentityProviders()

        A list representing an Amazon Cognito user pool and its client ID.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCognitoIdentityProviders() method.

        Returns:
        A list representing an Amazon Cognito user pool and its client ID.

      • hasSamlProviderARNs

        public final boolean hasSamlProviderARNs()
        For responses, this returns true if the service returned a value for the SamlProviderARNs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • samlProviderARNs

        public final List<String> samlProviderARNs()

        An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSamlProviderARNs() method.

        Returns:
        An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

      • hasIdentityPoolTags

        public final boolean hasIdentityPoolTags()
        For responses, this returns true if the service returned a value for the IdentityPoolTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • identityPoolTags

        public final Map<String,​String> identityPoolTags()

        The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIdentityPoolTags() method.

        Returns:
        The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object