[ aws . cognito-identity ]

set-principal-tag-attribute-map

Description

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  set-principal-tag-attribute-map
--identity-pool-id <value>
--identity-provider-name <value>
[--use-defaults | --no-use-defaults]
[--principal-tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--identity-pool-id (string)

The ID of the Identity Pool you want to set attribute mappings for.

--identity-provider-name (string)

The provider name you want to use for attribute mappings.

--use-defaults | --no-use-defaults (boolean)

You can use this operation to use default (username and clientID) attribute mappings.

--principal-tags (map)

You can use this operation to add principal tags.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

IdentityPoolId -> (string)

The ID of the Identity Pool you want to set attribute mappings for.

IdentityProviderName -> (string)

The provider name you want to use for attribute mappings.

UseDefaults -> (boolean)

You can use this operation to select default (username and clientID) attribute mappings.

PrincipalTags -> (map)

You can use this operation to add principal tags. The PrincipalTags operation enables you to reference user attributes in your IAM permissions policy.

key -> (string)

value -> (string)