Skip to content

Describe User Stack Associations

appstream_describe_user_stack_associations R Documentation

Retrieves a list that describes the UserStackAssociation objects

Description

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

  • The stack name

  • The user name (email address of the user associated with the stack) and the authentication type for the user

Usage

appstream_describe_user_stack_associations(StackName, UserName,
  AuthenticationType, MaxResults, NextToken)

Arguments

StackName

The name of the stack that is associated with the user.

UserName

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

AuthenticationType

The authentication type for the user who is associated with the stack. You must specify USERPOOL.

MaxResults

The maximum size of each page of results.

NextToken

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Value

A list with the following syntax: 

list(
  UserStackAssociations = list(
    list(
      StackName = "string",
      UserName = "string",
      AuthenticationType = "API"|"SAML"|"USERPOOL"|"AWS_AD",
      SendEmailNotification = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_user_stack_associations(
  StackName = "string",
  UserName = "string",
  AuthenticationType = "API"|"SAML"|"USERPOOL"|"AWS_AD",
  MaxResults = 123,
  NextToken = "string"
)