Class: Aws::QBusiness::Types::CreateSubscriptionRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application the subscription should be added to.

Returns:

  • (String) 


2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2595

class CreateSubscriptionRequest < Struct.new(
  :application_id,
  :principal,
  :type,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that you provide to identify the request to create a subscription for your Amazon Q Business application.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2595

class CreateSubscriptionRequest < Struct.new(
  :application_id,
  :principal,
  :type,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#principal ⇒ Types::SubscriptionPrincipal

The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

Returns:



2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2595

class CreateSubscriptionRequest < Struct.new(
  :application_id,
  :principal,
  :type,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of Amazon Q Business subscription you want to create.

Returns:

  • (String) 


2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2595

class CreateSubscriptionRequest < Struct.new(
  :application_id,
  :principal,
  :type,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end