You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentity::Types::GetIdentityPoolRolesResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb

Overview

Returned in response to a successful GetIdentityPoolRoles operation.

Instance Attribute Summary collapse

Instance Attribute Details

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


400
401
402
403
404
405
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 400

class GetIdentityPoolRolesResponse < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  include Aws::Structure
end

#role_mappingsHash<String,Types::RoleMapping>

How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Returns:



400
401
402
403
404
405
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 400

class GetIdentityPoolRolesResponse < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  include Aws::Structure
end

#rolesHash<String,String>

The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

Returns:

  • (Hash<String,String>)


400
401
402
403
404
405
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 400

class GetIdentityPoolRolesResponse < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  include Aws::Structure
end