Class: Aws::Chatbot::Types::CreateCustomActionRequest

Inherits:

Struct

• Object
• Struct
• Aws::Chatbot::Types::CreateCustomActionRequest

Defined in:

gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action_name ⇒ String

  The name of the custom action.

• #alias_name ⇒ String

  The name used to invoke this action in a chat channel.

• #attachments ⇒ Array<Types::CustomActionAttachment>

  Defines when this custom action button should be attached to a notification.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #definition ⇒ Types::CustomActionDefinition

  The definition of the command to run when invoked as an alias or as an action button.

• #tags ⇒ Array<Types::Tag>

  A map of tags assigned to a resource.

Instance Attribute Details

#action_name ⇒ String

The name of the custom action. This name is included in the Amazon Resource Name (ARN).

Returns:

• (String)

# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 342

class CreateCustomActionRequest < Struct.new(
  :definition,
  :alias_name,
  :attachments,
  :tags,
  :client_token,
  :action_name)
  SENSITIVE = []
  include Aws::Structure
end

#alias_name ⇒ String

The name used to invoke this action in a chat channel. For example, @aws run my-alias.

Returns:

• (String)

# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 342

class CreateCustomActionRequest < Struct.new(
  :definition,
  :alias_name,
  :attachments,
  :tags,
  :client_token,
  :action_name)
  SENSITIVE = []
  include Aws::Structure
end

#attachments ⇒ Array<Types::CustomActionAttachment>

Defines when this custom action button should be attached to a notification.

Returns:

• (Array<Types::CustomActionAttachment>)

# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 342

class CreateCustomActionRequest < Struct.new(
  :definition,
  :alias_name,
  :attachments,
  :tags,
  :client_token,
  :action_name)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the SDK.

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

Returns:

• (String)

# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 342

class CreateCustomActionRequest < Struct.new(
  :definition,
  :alias_name,
  :attachments,
  :tags,
  :client_token,
  :action_name)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ Types::CustomActionDefinition

The definition of the command to run when invoked as an alias or as an action button.

Returns:

• (Types::CustomActionDefinition)

# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 342

class CreateCustomActionRequest < Struct.new(
  :definition,
  :alias_name,
  :attachments,
  :tags,
  :client_token,
  :action_name)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 342

class CreateCustomActionRequest < Struct.new(
  :definition,
  :alias_name,
  :attachments,
  :tags,
  :client_token,
  :action_name)
  SENSITIVE = []
  include Aws::Structure
end