API Evangelist conversational phrasing for Amazon Cognito Identity API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon Cognito Identity API
  version: 1.0.0
extends: openapi/amazon-cognito-amazon-cognito-identity-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 23
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.CreateIdentityPool'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an identity pool for federated users
      effect: write
      questions:
      - How do I set up a new Cognito identity pool so my app users can get AWS credentials?
      - Can a new identity pool allow guest access for unauthenticated users?
      - Which login providers can I attach when creating an identity pool, like SAML or OpenID Connect?
      instructions:
      - text: Create an identity pool named {name} that does not allow unauthenticated identities.
        slots:
          name: requestBody.IdentityPoolName
      - text: Create identity pool {name} with guest access set to {allow_guests} and developer provider {developer_provider}.
        slots:
          name: requestBody.IdentityPoolName
          allow_guests: requestBody.AllowUnauthenticatedIdentities
          developer_provider: requestBody.DeveloperProviderName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.DeleteIdentities'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete identities from an identity pool
      effect: destructive
      questions:
      - How many identities can I remove from an identity pool in one call?
      - Can I bulk delete a batch of federated identity IDs I no longer need?
      instructions:
      - text: Delete the identities {identity_ids} from their identity pool.
        slots:
          identity_ids: requestBody.IdentityIdsToDelete
      - text: 'Remove this batch of up to 60 federated identities: {identity_ids}.'
        slots:
          identity_ids: requestBody.IdentityIdsToDelete
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.DeleteIdentityPool'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity pool
      effect: destructive
      questions:
      - How do I permanently remove a Cognito identity pool I am no longer using?
      - What happens to the identities in an identity pool when the pool itself is deleted?
      instructions:
      - text: Delete identity pool {identity_pool_id}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
      - text: Tear down the whole identity pool {identity_pool_id} and everything in it.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.DescribeIdentity'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up details of a single identity
      effect: read
      questions:
      - How can I see which logins are linked to a specific federated identity ID?
      - When was a given Cognito identity created and last modified?
      instructions:
      - text: Show me the details and linked logins for identity {identity_id}.
        slots:
          identity_id: requestBody.IdentityId
      - text: Describe the federated identity {identity_id}.
        slots:
          identity_id: requestBody.IdentityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.DescribeIdentityPool'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an identity pool's configuration
      effect: read
      questions:
      - How do I check which login providers and guest access settings an identity pool has?
      - Can I see the name and supported providers of an existing identity pool?
      instructions:
      - text: Describe identity pool {identity_pool_id}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
      - text: Show the configured providers and unauthenticated access setting for pool {identity_pool_id}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.GetCredentialsForIdentity'].post
  update:
    x-apievangelist-phrasing:
      intent: Get temporary AWS credentials for an identity
      effect: read
      questions:
      - How does a signed-in app user exchange their Cognito identity for temporary AWS credentials?
      - Can I request credentials for an identity under a specific custom IAM role?
      instructions:
      - text: Get temporary AWS credentials for identity {identity_id}.
        slots:
          identity_id: requestBody.IdentityId
      - text: Fetch AWS credentials for identity {identity_id} assuming role {role_arn}.
        slots:
          identity_id: requestBody.IdentityId
          role_arn: requestBody.CustomRoleArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.GetId'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate or retrieve a Cognito identity ID
      effect: write
      questions:
      - How does my app obtain a Cognito identity ID for a user in my identity pool?
      - What happens if I pass several logins when requesting an identity ID?
      instructions:
      - text: Get or create a Cognito identity ID in pool {identity_pool_id}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
      - text: Generate an identity ID in pool {identity_pool_id} for logins {logins}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
          logins: requestBody.Logins
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.GetIdentityPoolRoles'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the IAM roles assigned to an identity pool
      effect: read
      questions:
      - Which IAM roles do authenticated and guest users in my identity pool assume?
      - How can I review the role mapping rules on an identity pool?
      instructions:
      - text: Show the roles and role mappings for identity pool {identity_pool_id}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
      - text: List which IAM roles pool {identity_pool_id} hands out.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.GetOpenIdToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an OpenID token for an identity
      effect: read
      questions:
      - How do I get an OpenID Connect token for an existing Cognito identity?
      - Can I fetch an OIDC token for an identity using its linked login tokens?
      instructions:
      - text: Get an OpenID token for identity {identity_id}.
        slots:
          identity_id: requestBody.IdentityId
      - text: Issue an OpenID Connect token for identity {identity_id} using logins {logins}.
        slots:
          identity_id: requestBody.IdentityId
          logins: requestBody.Logins
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.GetOpenIdTokenForDeveloperIdentity'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an OpenID token for a developer-authenticated user
      effect: write
      questions:
      - How does my own backend auth system register a user and get them a Cognito OpenID token?
      - Can I set how long the token lasts when issuing it for a developer-authenticated identity?
      - Is it possible to attach principal tags when my backend requests a token for its user?
      instructions:
      - text: Get an OpenID token in pool {identity_pool_id} for my backend user with logins {logins}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
          logins: requestBody.Logins
      - text: Register developer user logins {logins} in pool {identity_pool_id} and issue a token valid for {duration} seconds.
        slots:
          logins: requestBody.Logins
          identity_pool_id: requestBody.IdentityPoolId
          duration: requestBody.TokenDuration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.GetPrincipalTagAttributeMap'].post
  update:
    x-apievangelist-phrasing:
      intent: View principal tag mappings for a provider
      effect: read
      questions:
      - Which user attributes are mapped to principal tags for an identity provider in my pool?
      - How can I check the attribute-to-session-tag mapping used for access control in an identity pool?
      instructions:
      - text: Show the principal tag mappings for provider {provider} in identity pool {identity_pool_id}.
        slots:
          provider: requestBody.IdentityProviderName
          identity_pool_id: requestBody.IdentityPoolId
      - text: Get the attribute-to-tag map that pool {identity_pool_id} uses for {provider}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
          provider: requestBody.IdentityProviderName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.ListIdentities'].post
  update:
    x-apievangelist-phrasing:
      intent: List the identities in an identity pool
      effect: read
      questions:
      - How do I see all the identities that exist in one identity pool?
      - Can I hide disabled identities when listing a pool's identities?
      instructions:
      - text: List up to {max} identities in identity pool {identity_pool_id}.
        slots:
          max: requestBody.MaxResults
          identity_pool_id: requestBody.IdentityPoolId
      - text: 'List the enabled identities in pool {identity_pool_id}, {max} per page, hiding disabled ones: {hide_disabled}.'
        slots:
          identity_pool_id: requestBody.IdentityPoolId
          max: requestBody.MaxResults
          hide_disabled: requestBody.HideDisabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.ListIdentityPools'].post
  update:
    x-apievangelist-phrasing:
      intent: List identity pools in the account
      effect: read
      questions:
      - What identity pools exist in my AWS account?
      - Can I page through all my Cognito identity pools a few at a time?
      instructions:
      - text: List my identity pools, {max} at a time.
        slots:
          max: requestBody.MaxResults
      - text: Show the next page of identity pools after token {next_token}.
        slots:
          next_token: requestBody.NextToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.ListTagsForResource'].post
  update:
    x-apievangelist-phrasing:
      intent: List tags on an identity pool
      effect: read
      questions:
      - How do I see the cost allocation tags assigned to an identity pool?
      - What tags are currently on my federated identity pool?
      instructions:
      - text: List the tags on identity pool {resource_arn}.
        slots:
          resource_arn: requestBody.ResourceArn
      - text: Show me every tag key and value attached to pool ARN {resource_arn}.
        slots:
          resource_arn: requestBody.ResourceArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.LookupDeveloperIdentity'].post
  update:
    x-apievangelist-phrasing:
      intent: Find the identity for a developer user identifier
      effect: read
      questions:
      - How do I find which Cognito identity ID belongs to a user ID from my own backend?
      - Can I look up all developer user identifiers linked to one identity ID?
      instructions:
      - text: Look up the identity ID for developer user {developer_user} in pool {identity_pool_id}.
        slots:
          developer_user: requestBody.DeveloperUserIdentifier
          identity_pool_id: requestBody.IdentityPoolId
      - text: Find the developer user identifiers linked to identity {identity_id} in pool {identity_pool_id}.
        slots:
          identity_id: requestBody.IdentityId
          identity_pool_id: requestBody.IdentityPoolId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.MergeDeveloperIdentities'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge two developer-authenticated users
      effect: write
      questions:
      - How can I combine two developer-authenticated users into a single Cognito identity?
      - Can I merge users from my backend login who ended up with different identity IDs?
      instructions:
      - text: Merge developer user {source} into {destination} for provider {provider} in pool {identity_pool_id}.
        slots:
          source: requestBody.SourceUserIdentifier
          destination: requestBody.DestinationUserIdentifier
          provider: requestBody.DeveloperProviderName
          identity_pool_id: requestBody.IdentityPoolId
      - text: Fold backend user {source} into user {destination}'s identity in pool {identity_pool_id} under provider {provider}.
        slots:
          source: requestBody.SourceUserIdentifier
          destination: requestBody.DestinationUserIdentifier
          identity_pool_id: requestBody.IdentityPoolId
          provider: requestBody.DeveloperProviderName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.SetIdentityPoolRoles'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the IAM roles for an identity pool
      effect: write
      questions:
      - How do I assign authenticated and unauthenticated IAM roles to an identity pool?
      - Can I add rules that map users to different roles based on their token claims?
      instructions:
      - text: Set the roles for identity pool {identity_pool_id} to {roles}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
          roles: requestBody.Roles
      - text: Assign roles {roles} and role mappings {mappings} to pool {identity_pool_id}.
        slots:
          roles: requestBody.Roles
          mappings: requestBody.RoleMappings
          identity_pool_id: requestBody.IdentityPoolId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.SetPrincipalTagAttributeMap'].post
  update:
    x-apievangelist-phrasing:
      intent: Map user attributes to principal tags
      effect: write
      questions:
      - How do I map user attributes from a provider into session tags for attribute-based access control?
      - Can I go back to the default principal tag mappings for a provider in my identity pool?
      instructions:
      - text: Set principal tag mappings {tags} for provider {provider} in identity pool {identity_pool_id}.
        slots:
          tags: requestBody.PrincipalTags
          provider: requestBody.IdentityProviderName
          identity_pool_id: requestBody.IdentityPoolId
      - text: 'Switch provider {provider} in pool {identity_pool_id} to default tag mappings: {use_defaults}.'
        slots:
          provider: requestBody.IdentityProviderName
          identity_pool_id: requestBody.IdentityPoolId
          use_defaults: requestBody.UseDefaults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.TagResource'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag an identity pool
      effect: write
      questions:
      - How do I add cost allocation tags to an identity pool?
      - Can I label a federated identity pool with key-value tags for billing?
      instructions:
      - text: Add tags {tags} to identity pool {resource_arn}.
        slots:
          tags: requestBody.Tags
          resource_arn: requestBody.ResourceArn
      - text: Tag pool ARN {resource_arn} with {tags}.
        slots:
          resource_arn: requestBody.ResourceArn
          tags: requestBody.Tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.UnlinkDeveloperIdentity'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink a developer user from an identity
      effect: destructive
      questions:
      - How do I detach a user ID from my own backend from an existing Cognito identity?
      - What happens to a developer-authenticated user after it is unlinked from its identity?
      instructions:
      - text: Unlink developer user {developer_user} of provider {provider} from identity {identity_id} in pool {identity_pool_id}.
        slots:
          developer_user: requestBody.DeveloperUserIdentifier
          provider: requestBody.DeveloperProviderName
          identity_id: requestBody.IdentityId
          identity_pool_id: requestBody.IdentityPoolId
      - text: Detach backend user {developer_user} from identity {identity_id} (pool {identity_pool_id}, provider {provider}).
        slots:
          developer_user: requestBody.DeveloperUserIdentifier
          identity_id: requestBody.IdentityId
          identity_pool_id: requestBody.IdentityPoolId
          provider: requestBody.DeveloperProviderName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.UnlinkIdentity'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink a federated login from an identity
      effect: destructive
      questions:
      - How do I remove a social or federated login from a user's Cognito identity?
      - What happens if I unlink the last login on an identity?
      instructions:
      - text: Unlink logins {logins_to_remove} from identity {identity_id} using current logins {logins}.
        slots:
          logins_to_remove: requestBody.LoginsToRemove
          identity_id: requestBody.IdentityId
          logins: requestBody.Logins
      - text: Remove provider {logins_to_remove} from identity {identity_id}, authenticating with {logins}.
        slots:
          logins_to_remove: requestBody.LoginsToRemove
          identity_id: requestBody.IdentityId
          logins: requestBody.Logins
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.UntagResource'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from an identity pool
      effect: destructive
      questions:
      - How do I delete tags I no longer want on an identity pool?
      - Can I strip specific tag keys off a federated identity pool?
      instructions:
      - text: Remove tag keys {tag_keys} from identity pool {resource_arn}.
        slots:
          tag_keys: requestBody.TagKeys
          resource_arn: requestBody.ResourceArn
      - text: Untag pool ARN {resource_arn}, dropping keys {tag_keys}.
        slots:
          resource_arn: requestBody.ResourceArn
          tag_keys: requestBody.TagKeys
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#X-Amz-Target=AWSCognitoIdentityService.UpdateIdentityPool'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an identity pool's settings
      effect: write
      questions:
      - How do I change the login providers or guest access on an existing identity pool?
      - Can I rename an identity pool after it has been created?
      instructions:
      - text: 'Update identity pool {identity_pool_id}: rename it to {name} and set guest access to {allow_guests}.'
        slots:
          identity_pool_id: requestBody.IdentityPoolId
          name: requestBody.IdentityPoolName
          allow_guests: requestBody.AllowUnauthenticatedIdentities
      - text: Change the supported login providers on existing pool {identity_pool_id} ({name}, guest access {allow_guests}) to {providers}.
        slots:
          identity_pool_id: requestBody.IdentityPoolId
          name: requestBody.IdentityPoolName
          allow_guests: requestBody.AllowUnauthenticatedIdentities
          providers: requestBody.SupportedLoginProviders
      method: generated
      generated: '2026-10-01'