You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppStream::Types::DescribeUserStackAssociationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Note:

When making an API call, you may pass DescribeUserStackAssociationsRequest data as a hash:

{
  stack_name: "String",
  user_name: "Username",
  authentication_type: "API", # accepts API, SAML, USERPOOL
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_typeString

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

Returns:

  • (String)


1774
1775
1776
1777
1778
1779
1780
1781
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1774

class DescribeUserStackAssociationsRequest < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum size of each page of results.

Returns:

  • (Integer)


1774
1775
1776
1777
1778
1779
1780
1781
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1774

class DescribeUserStackAssociationsRequest < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


1774
1775
1776
1777
1778
1779
1780
1781
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1774

class DescribeUserStackAssociationsRequest < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end

#stack_nameString

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

Returns:

  • (String)


1774
1775
1776
1777
1778
1779
1780
1781
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1774

class DescribeUserStackAssociationsRequest < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end

#user_nameString

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

Users' email addresses are case-sensitive.

Returns:

  • (String)


1774
1775
1776
1777
1778
1779
1780
1781
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1774

class DescribeUserStackAssociationsRequest < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end