Amazon Cognito · JSON Structure

Identity Pools Set Principal Tag Attribute Map Input Structure

SetPrincipalTagAttributeMapInput schema from Amazon Cognito API

Type: object Properties: 4 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

SetPrincipalTagAttributeMapInput is a JSON Structure definition published by Amazon Cognito, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

IdentityPoolId IdentityProviderName UseDefaults PrincipalTags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/identity-pools-set-principal-tag-attribute-map-input-structure.json",
  "name": "SetPrincipalTagAttributeMapInput",
  "description": "SetPrincipalTagAttributeMapInput schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "IdentityPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolId"
        },
        {
          "description": "The ID of the Identity Pool you want to set attribute mappings for."
        }
      ]
    },
    "IdentityProviderName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityProviderName"
        },
        {
          "description": "The provider name you want to use for attribute mappings."
        }
      ]
    },
    "UseDefaults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UseDefaults"
        },
        {
          "description": "You can use this operation to use default (username and clientID) attribute mappings."
        }
      ]
    },
    "PrincipalTags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PrincipalTags"
        },
        {
          "description": "You can use this operation to add principal tags."
        }
      ]
    }
  },
  "required": [
    "IdentityPoolId",
    "IdentityProviderName"
  ]
}