AWSCognitoIdentityGetCredentialsForIdentityInput

Objective-C

@interface AWSCognitoIdentityGetCredentialsForIdentityInput : AWSRequest

Swift

class AWSCognitoIdentityGetCredentialsForIdentityInput : AWSRequest

Input to the GetCredentialsForIdentity action.

Required parameters: [IdentityId]

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable customRoleArn;

    Swift

    var customRoleArn: String? { get set }

  • A unique identifier in the format REGION:GUID.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable identityId;

    Swift

    var identityId: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable logins;

    Swift

    var logins: [String : String]? { get set }