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

Class: Aws::WorkDocs::Types::CreateNotificationSubscriptionRequest

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

Overview

Note:

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

{
  organization_id: "IdType", # required
  endpoint: "SubscriptionEndPointType", # required
  protocol: "HTTPS", # required, accepts HTTPS
  subscription_type: "ALL", # required, accepts ALL
}

Instance Attribute Summary collapse

Instance Attribute Details

#endpointString

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://".

Returns:

  • (String)


501
502
503
504
505
506
507
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 501

class CreateNotificationSubscriptionRequest < Struct.new(
  :organization_id,
  :endpoint,
  :protocol,
  :subscription_type)
  include Aws::Structure
end

#organization_idString

The ID of the organization.

Returns:

  • (String)


501
502
503
504
505
506
507
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 501

class CreateNotificationSubscriptionRequest < Struct.new(
  :organization_id,
  :endpoint,
  :protocol,
  :subscription_type)
  include Aws::Structure
end

#protocolString

The protocol to use. The supported value is https, which delivers JSON-encoded messasges using HTTPS POST.

Returns:

  • (String)


501
502
503
504
505
506
507
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 501

class CreateNotificationSubscriptionRequest < Struct.new(
  :organization_id,
  :endpoint,
  :protocol,
  :subscription_type)
  include Aws::Structure
end

#subscription_typeString

The notification type.

Returns:

  • (String)


501
502
503
504
505
506
507
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 501

class CreateNotificationSubscriptionRequest < Struct.new(
  :organization_id,
  :endpoint,
  :protocol,
  :subscription_type)
  include Aws::Structure
end