AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

describe-rule

Description

Describes a rule for the specified Amazon Connect instance.

See also: AWS API Documentation

Synopsis

  describe-rule
--instance-id <value>
--rule-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

--rule-id (string)

A unique identifier for the rule.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Rule -> (structure)

Information about the rule.

Name -> (string)

The name of the rule.

RuleId -> (string)

A unique identifier for the rule.

RuleArn -> (string)

The Amazon Resource Name (ARN) of the rule.

TriggerEventSource -> (structure)

The event source to trigger the rule.

EventSourceName -> (string)

The name of the event source.

IntegrationAssociationId -> (string)

The identifier for the integration association.

Function -> (string)

The conditions of the rule.

Actions -> (list)

A list of actions to be run when the rule is triggered.

(structure)

Information about the action to be performed when a rule is triggered.

ActionType -> (string)

The type of action that creates a rule.

TaskAction -> (structure)

Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Name -> (string)

The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .

Description -> (string)

The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .

ContactFlowId -> (string)

The identifier of the flow.

References -> (map)

Information about the reference when the referenceType is URL . Otherwise, null. (Supports variable injection in the Value field.)

key -> (string)

value -> (structure)

Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

Value -> (string)

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

Type -> (string)

The type of the reference. DATE must be of type Epoch timestamp.

Status -> (string)

Arn -> (string)

StatusReason -> (string)

EventBridgeAction -> (structure)

Information about the EventBridge action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

Name -> (string)

The name.

AssignContactCategoryAction -> (structure)

Information about the contact category action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

SendNotificationAction -> (structure)

Information about the send notification action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

DeliveryMethod -> (string)

Notification delivery method.

Subject -> (string)

The subject of the email if the delivery method is EMAIL . Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .

Content -> (string)

Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .

ContentType -> (string)

Content type format.

Recipient -> (structure)

Notification recipient.

UserTags -> (map)

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.

key -> (string)

value -> (string)

UserIds -> (list)

A list of user IDs.

(string)

CreateCaseAction -> (structure)

Information about the create case action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable .

Fields -> (list)

An array of objects with Field ID and Value data.

(structure)

Object for case field values.

Id -> (string)

Unique identifier of a field.

Value -> (structure)

Union of potential field value types.

BooleanValue -> (boolean)

A Boolean number value type.

DoubleValue -> (double)

A Double number value type.

EmptyValue -> (structure)

An empty value.

StringValue -> (string)

String value type.

TemplateId -> (string)

A unique identifier of a template.

UpdateCaseAction -> (structure)

Information about the update case action.

Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate .

Fields -> (list)

An array of objects with Field ID and Value data.

(structure)

Object for case field values.

Id -> (string)

Unique identifier of a field.

Value -> (structure)

Union of potential field value types.

BooleanValue -> (boolean)

A Boolean number value type.

DoubleValue -> (double)

A Double number value type.

EmptyValue -> (structure)

An empty value.

StringValue -> (string)

String value type.

EndAssociatedTasksAction -> (structure)

Information about the end associated tasks action.

Supported only for TriggerEventSource values: OnCaseUpdate .

SubmitAutoEvaluationAction -> (structure)

Information about the submit automated evaluation action.

EvaluationFormId -> (string)

The identifier of the auto-evaluation enabled form.

PublishStatus -> (string)

The publish status of the rule.

CreatedTime -> (timestamp)

The timestamp for when the rule was created.

LastUpdatedTime -> (timestamp)

The timestamp for the when the rule was last updated.

LastUpdatedBy -> (string)

The Amazon Resource Name (ARN) of the user who last updated the rule.

Tags -> (map)

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

key -> (string)

value -> (string)