Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. chatbot
  5. getCustomAction

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.chatbot.getCustomAction

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::Chatbot::CustomAction Resource Type

Using getCustomAction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCustomAction(args: GetCustomActionArgs, opts?: InvokeOptions): Promise<GetCustomActionResult>
function getCustomActionOutput(args: GetCustomActionOutputArgs, opts?: InvokeOptions): Output<GetCustomActionResult>
Copy
def get_custom_action(custom_action_arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCustomActionResult
def get_custom_action_output(custom_action_arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCustomActionResult]
Copy
func LookupCustomAction(ctx *Context, args *LookupCustomActionArgs, opts ...InvokeOption) (*LookupCustomActionResult, error)
func LookupCustomActionOutput(ctx *Context, args *LookupCustomActionOutputArgs, opts ...InvokeOption) LookupCustomActionResultOutput
Copy

> Note: This function is named LookupCustomAction in the Go SDK.

public static class GetCustomAction 
{
    public static Task<GetCustomActionResult> InvokeAsync(GetCustomActionArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomActionResult> Invoke(GetCustomActionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomActionResult> getCustomAction(GetCustomActionArgs args, InvokeOptions options)
public static Output<GetCustomActionResult> getCustomAction(GetCustomActionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:chatbot:getCustomAction
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CustomActionArn This property is required. string
The fully defined ARN of the custom action.
CustomActionArn This property is required. string
The fully defined ARN of the custom action.
customActionArn This property is required. String
The fully defined ARN of the custom action.
customActionArn This property is required. string
The fully defined ARN of the custom action.
custom_action_arn This property is required. str
The fully defined ARN of the custom action.
customActionArn This property is required. String
The fully defined ARN of the custom action.

getCustomAction Result

The following output properties are available:

AliasName string
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
Attachments List<Pulumi.AwsNative.Chatbot.Outputs.CustomActionAttachment>
Defines when this custom action button should be attached to a notification.
CustomActionArn string
The fully defined ARN of the custom action.
Definition Pulumi.AwsNative.Chatbot.Outputs.CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The tags to add to the configuration.
AliasName string
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
Attachments []CustomActionAttachment
Defines when this custom action button should be attached to a notification.
CustomActionArn string
The fully defined ARN of the custom action.
Definition CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
Tags Tag
The tags to add to the configuration.
aliasName String
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments List<CustomActionAttachment>
Defines when this custom action button should be attached to a notification.
customActionArn String
The fully defined ARN of the custom action.
definition CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
tags List<Tag>
The tags to add to the configuration.
aliasName string
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments CustomActionAttachment[]
Defines when this custom action button should be attached to a notification.
customActionArn string
The fully defined ARN of the custom action.
definition CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
tags Tag[]
The tags to add to the configuration.
alias_name str
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments Sequence[CustomActionAttachment]
Defines when this custom action button should be attached to a notification.
custom_action_arn str
The fully defined ARN of the custom action.
definition CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
tags Sequence[root_Tag]
The tags to add to the configuration.
aliasName String
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments List<Property Map>
Defines when this custom action button should be attached to a notification.
customActionArn String
The fully defined ARN of the custom action.
definition Property Map
The definition of the command to run when invoked as an alias or as an action button.
tags List<Property Map>
The tags to add to the configuration.

Supporting Types

CustomActionAttachment

ButtonText string
The text of the button that appears on the notification.
Criteria List<Pulumi.AwsNative.Chatbot.Inputs.CustomActionAttachmentCriteria>
The criteria for when a button should be shown based on values in the notification.
NotificationType string
The type of notification that the custom action should be attached to.
Variables Dictionary<string, string>
The variables to extract from the notification.
ButtonText string
The text of the button that appears on the notification.
Criteria []CustomActionAttachmentCriteria
The criteria for when a button should be shown based on values in the notification.
NotificationType string
The type of notification that the custom action should be attached to.
Variables map[string]string
The variables to extract from the notification.
buttonText String
The text of the button that appears on the notification.
criteria List<CustomActionAttachmentCriteria>
The criteria for when a button should be shown based on values in the notification.
notificationType String
The type of notification that the custom action should be attached to.
variables Map<String,String>
The variables to extract from the notification.
buttonText string
The text of the button that appears on the notification.
criteria CustomActionAttachmentCriteria[]
The criteria for when a button should be shown based on values in the notification.
notificationType string
The type of notification that the custom action should be attached to.
variables {[key: string]: string}
The variables to extract from the notification.
button_text str
The text of the button that appears on the notification.
criteria Sequence[CustomActionAttachmentCriteria]
The criteria for when a button should be shown based on values in the notification.
notification_type str
The type of notification that the custom action should be attached to.
variables Mapping[str, str]
The variables to extract from the notification.
buttonText String
The text of the button that appears on the notification.
criteria List<Property Map>
The criteria for when a button should be shown based on values in the notification.
notificationType String
The type of notification that the custom action should be attached to.
variables Map<String>
The variables to extract from the notification.

CustomActionAttachmentCriteria

Operator This property is required. Pulumi.AwsNative.Chatbot.CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
VariableName This property is required. string
The name of the variable to operate on.
Value string
A value that is compared with the actual value of the variable based on the behavior of the operator.
Operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
VariableName This property is required. string
The name of the variable to operate on.
Value string
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
variableName This property is required. String
The name of the variable to operate on.
value String
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
variableName This property is required. string
The name of the variable to operate on.
value string
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
variable_name This property is required. str
The name of the variable to operate on.
value str
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. "HAS_VALUE" | "EQUALS"
The operation to perform on the named variable.
variableName This property is required. String
The name of the variable to operate on.
value String
A value that is compared with the actual value of the variable based on the behavior of the operator.

CustomActionAttachmentCriteriaOperator

CustomActionDefinition

CommandText This property is required. string
The command string to run which may include variables by prefixing with a dollar sign ($).
CommandText This property is required. string
The command string to run which may include variables by prefixing with a dollar sign ($).
commandText This property is required. String
The command string to run which may include variables by prefixing with a dollar sign ($).
commandText This property is required. string
The command string to run which may include variables by prefixing with a dollar sign ($).
command_text This property is required. str
The command string to run which may include variables by prefixing with a dollar sign ($).
commandText This property is required. String
The command string to run which may include variables by prefixing with a dollar sign ($).

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native