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

Class GetCredentialsForIdentityRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityRequest
software.amazon.awssdk.services.cognitoidentity.model.GetCredentialsForIdentityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCredentialsForIdentityRequest.Builder,GetCredentialsForIdentityRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetCredentialsForIdentityRequest extends CognitoIdentityRequest implements ToCopyableBuilder<GetCredentialsForIdentityRequest.Builder,GetCredentialsForIdentityRequest>

Input to the GetCredentialsForIdentity action.

  • Method Details

    • identityId

      public final String identityId()

      A unique identifier in the format REGION:GUID.

      Returns:
      A unique identifier in the format REGION:GUID.

    • hasLogins

      public final boolean hasLogins()
      For responses, this returns true if the service returned a value for the Logins 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.

    • logins

      public final Map<String,String> logins()

      A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

      Logins should not be specified when trying to get credentials for an unauthenticated identity.

      The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

      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 hasLogins() method.

      Returns:
      A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

      Logins should not be specified when trying to get credentials for an unauthenticated identity.

      The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

    • customRoleArn

      public final String customRoleArn()

      The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

      Returns:
      The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

    • toBuilder

      public GetCredentialsForIdentityRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetCredentialsForIdentityRequest.Builder,GetCredentialsForIdentityRequest>
      Specified by:
      toBuilder in class CognitoIdentityRequest

    • builder

      public static GetCredentialsForIdentityRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCredentialsForIdentityRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo