cognitoidentity_set_identity_pool_roles: Sets the roles for an identity pool

Description Usage Arguments Details Request syntax

View source: R/cognitoidentity_operations.R

Description

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

Usage

1
2
cognitoidentity_set_identity_pool_roles(IdentityPoolId, Roles,
  RoleMappings)

Arguments

IdentityPoolId

[required] An identity pool ID in the format REGION:GUID.

Roles

[required] The map of roles associated with this pool. For a given role, the key will be either \"authenticated\" or \"unauthenticated\" and the value will be the Role ARN.

RoleMappings

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\".

Up to 25 rules can be specified per identity provider.

Details

You must use AWS Developer credentials to call this API.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
svc$set_identity_pool_roles(
  IdentityPoolId = "string",
  Roles = list(
    "string"
  ),
  RoleMappings = list(
    list(
      Type = "Token"|"Rules",
      AmbiguousRoleResolution = "AuthenticatedRole"|"Deny",
      RulesConfiguration = list(
        Rules = list(
          list(
            Claim = "string",
            MatchType = "Equals"|"Contains"|"StartsWith"|"NotEqual",
            Value = "string",
            RoleARN = "string"
          )
        )
      )
    )
  )
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.