diff --git a/clients/client-cloudwatch-events/src/commands/CancelReplayCommand.ts b/clients/client-cloudwatch-events/src/commands/CancelReplayCommand.ts index c47c5f6ffd11..cd8455de37eb 100644 --- a/clients/client-cloudwatch-events/src/commands/CancelReplayCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/CancelReplayCommand.ts @@ -50,7 +50,7 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad * const response = await client.send(command); * // { // CancelReplayResponse * // ReplayArn: "STRING_VALUE", - * // State: "STRING_VALUE", + * // State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED", * // StateReason: "STRING_VALUE", * // }; * diff --git a/clients/client-cloudwatch-events/src/commands/CreateApiDestinationCommand.ts b/clients/client-cloudwatch-events/src/commands/CreateApiDestinationCommand.ts index 196c3d2b37c0..e126a3b3606f 100644 --- a/clients/client-cloudwatch-events/src/commands/CreateApiDestinationCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/CreateApiDestinationCommand.ts @@ -49,14 +49,14 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR * Description: "STRING_VALUE", * ConnectionArn: "STRING_VALUE", // required * InvocationEndpoint: "STRING_VALUE", // required - * HttpMethod: "STRING_VALUE", // required + * HttpMethod: "POST" || "GET" || "HEAD" || "OPTIONS" || "PUT" || "PATCH" || "DELETE", // required * InvocationRateLimitPerSecond: Number("int"), * }; * const command = new CreateApiDestinationCommand(input); * const response = await client.send(command); * // { // CreateApiDestinationResponse * // ApiDestinationArn: "STRING_VALUE", - * // ApiDestinationState: "STRING_VALUE", + * // ApiDestinationState: "ACTIVE" || "INACTIVE", * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), * // }; diff --git a/clients/client-cloudwatch-events/src/commands/CreateArchiveCommand.ts b/clients/client-cloudwatch-events/src/commands/CreateArchiveCommand.ts index 8d1fc58dae58..0a0b80765e69 100644 --- a/clients/client-cloudwatch-events/src/commands/CreateArchiveCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/CreateArchiveCommand.ts @@ -58,7 +58,7 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met * const response = await client.send(command); * // { // CreateArchiveResponse * // ArchiveArn: "STRING_VALUE", - * // State: "STRING_VALUE", + * // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED", * // StateReason: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // }; diff --git a/clients/client-cloudwatch-events/src/commands/CreateConnectionCommand.ts b/clients/client-cloudwatch-events/src/commands/CreateConnectionCommand.ts index 35302bf73ce2..e5d75e57e96d 100644 --- a/clients/client-cloudwatch-events/src/commands/CreateConnectionCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/CreateConnectionCommand.ts @@ -47,7 +47,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse, * const input = { // CreateConnectionRequest * Name: "STRING_VALUE", // required * Description: "STRING_VALUE", - * AuthorizationType: "STRING_VALUE", // required + * AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY", // required * AuthParameters: { // CreateConnectionAuthRequestParameters * BasicAuthParameters: { // CreateConnectionBasicAuthRequestParameters * Username: "STRING_VALUE", // required @@ -59,7 +59,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse, * ClientSecret: "STRING_VALUE", // required * }, * AuthorizationEndpoint: "STRING_VALUE", // required - * HttpMethod: "STRING_VALUE", // required + * HttpMethod: "GET" || "POST" || "PUT", // required * OAuthHttpParameters: { // ConnectionHttpParameters * HeaderParameters: [ // ConnectionHeaderParametersList * { // ConnectionHeaderParameter @@ -117,7 +117,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse, * const response = await client.send(command); * // { // CreateConnectionResponse * // ConnectionArn: "STRING_VALUE", - * // ConnectionState: "STRING_VALUE", + * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING", * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), * // }; diff --git a/clients/client-cloudwatch-events/src/commands/DeauthorizeConnectionCommand.ts b/clients/client-cloudwatch-events/src/commands/DeauthorizeConnectionCommand.ts index 921157149c8b..02c0ce40c812 100644 --- a/clients/client-cloudwatch-events/src/commands/DeauthorizeConnectionCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/DeauthorizeConnectionCommand.ts @@ -51,7 +51,7 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio * const response = await client.send(command); * // { // DeauthorizeConnectionResponse * // ConnectionArn: "STRING_VALUE", - * // ConnectionState: "STRING_VALUE", + * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING", * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), * // LastAuthorizedTime: new Date("TIMESTAMP"), diff --git a/clients/client-cloudwatch-events/src/commands/DeleteConnectionCommand.ts b/clients/client-cloudwatch-events/src/commands/DeleteConnectionCommand.ts index c0497c213727..7af04253e699 100644 --- a/clients/client-cloudwatch-events/src/commands/DeleteConnectionCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/DeleteConnectionCommand.ts @@ -50,7 +50,7 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse, * const response = await client.send(command); * // { // DeleteConnectionResponse * // ConnectionArn: "STRING_VALUE", - * // ConnectionState: "STRING_VALUE", + * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING", * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), * // LastAuthorizedTime: new Date("TIMESTAMP"), diff --git a/clients/client-cloudwatch-events/src/commands/DeleteRuleCommand.ts b/clients/client-cloudwatch-events/src/commands/DeleteRuleCommand.ts index 17d7cfa41d15..cac60cd44a18 100644 --- a/clients/client-cloudwatch-events/src/commands/DeleteRuleCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/DeleteRuleCommand.ts @@ -38,14 +38,11 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {} * @public *
Deletes the specified rule.
*Before you can delete the rule, you must remove all targets, using RemoveTargets.
- * *When you delete a rule, incoming events might continue to match to the deleted rule. Allow * a short period of time for changes to take effect.
- * *If you call delete rule multiple times for the same rule, all calls will succeed. When you
* call delete rule for a non-existent custom eventbus, ResourceNotFoundException
is
* returned.
Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These
* rules are created by those other Amazon Web Services services to support functionality in those services. You
* can delete these rules using the Force
option, but you should do so only if you
diff --git a/clients/client-cloudwatch-events/src/commands/DescribeApiDestinationCommand.ts b/clients/client-cloudwatch-events/src/commands/DescribeApiDestinationCommand.ts
index 11a3ea93c36d..ced5e91f37c7 100644
--- a/clients/client-cloudwatch-events/src/commands/DescribeApiDestinationCommand.ts
+++ b/clients/client-cloudwatch-events/src/commands/DescribeApiDestinationCommand.ts
@@ -52,10 +52,10 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat
* // ApiDestinationArn: "STRING_VALUE",
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
- * // ApiDestinationState: "STRING_VALUE",
+ * // ApiDestinationState: "ACTIVE" || "INACTIVE",
* // ConnectionArn: "STRING_VALUE",
* // InvocationEndpoint: "STRING_VALUE",
- * // HttpMethod: "STRING_VALUE",
+ * // HttpMethod: "POST" || "GET" || "HEAD" || "OPTIONS" || "PUT" || "PATCH" || "DELETE",
* // InvocationRateLimitPerSecond: Number("int"),
* // CreationTime: new Date("TIMESTAMP"),
* // LastModifiedTime: new Date("TIMESTAMP"),
diff --git a/clients/client-cloudwatch-events/src/commands/DescribeArchiveCommand.ts b/clients/client-cloudwatch-events/src/commands/DescribeArchiveCommand.ts
index 449bb4d00584..27593c56016f 100644
--- a/clients/client-cloudwatch-events/src/commands/DescribeArchiveCommand.ts
+++ b/clients/client-cloudwatch-events/src/commands/DescribeArchiveCommand.ts
@@ -54,7 +54,7 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _
* // EventSourceArn: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // EventPattern: "STRING_VALUE",
- * // State: "STRING_VALUE",
+ * // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
* // StateReason: "STRING_VALUE",
* // RetentionDays: Number("int"),
* // SizeBytes: Number("long"),
diff --git a/clients/client-cloudwatch-events/src/commands/DescribeConnectionCommand.ts b/clients/client-cloudwatch-events/src/commands/DescribeConnectionCommand.ts
index 8bf802b68f41..ea99503ad1ab 100644
--- a/clients/client-cloudwatch-events/src/commands/DescribeConnectionCommand.ts
+++ b/clients/client-cloudwatch-events/src/commands/DescribeConnectionCommand.ts
@@ -52,9 +52,9 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
* // ConnectionArn: "STRING_VALUE",
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
- * // ConnectionState: "STRING_VALUE",
+ * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
* // StateReason: "STRING_VALUE",
- * // AuthorizationType: "STRING_VALUE",
+ * // AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
* // SecretArn: "STRING_VALUE",
* // AuthParameters: { // ConnectionAuthResponseParameters
* // BasicAuthParameters: { // ConnectionBasicAuthResponseParameters
@@ -65,7 +65,7 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
* // ClientID: "STRING_VALUE",
* // },
* // AuthorizationEndpoint: "STRING_VALUE",
- * // HttpMethod: "STRING_VALUE",
+ * // HttpMethod: "GET" || "POST" || "PUT",
* // OAuthHttpParameters: { // ConnectionHttpParameters
* // HeaderParameters: [ // ConnectionHeaderParametersList
* // { // ConnectionHeaderParameter
diff --git a/clients/client-cloudwatch-events/src/commands/DescribeEventSourceCommand.ts b/clients/client-cloudwatch-events/src/commands/DescribeEventSourceCommand.ts
index 3b0d1bfa4091..a0f14fc14f53 100644
--- a/clients/client-cloudwatch-events/src/commands/DescribeEventSourceCommand.ts
+++ b/clients/client-cloudwatch-events/src/commands/DescribeEventSourceCommand.ts
@@ -55,7 +55,7 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes
* // CreationTime: new Date("TIMESTAMP"),
* // ExpirationTime: new Date("TIMESTAMP"),
* // Name: "STRING_VALUE",
- * // State: "STRING_VALUE",
+ * // State: "PENDING" || "ACTIVE" || "DELETED",
* // };
*
* ```
diff --git a/clients/client-cloudwatch-events/src/commands/DescribeReplayCommand.ts b/clients/client-cloudwatch-events/src/commands/DescribeReplayCommand.ts
index 9eaa7dbe72a6..032c888c5d0a 100644
--- a/clients/client-cloudwatch-events/src/commands/DescribeReplayCommand.ts
+++ b/clients/client-cloudwatch-events/src/commands/DescribeReplayCommand.ts
@@ -60,7 +60,7 @@ export interface DescribeReplayCommandOutput extends DescribeReplayResponse, __M
* // ReplayName: "STRING_VALUE",
* // ReplayArn: "STRING_VALUE",
* // Description: "STRING_VALUE",
- * // State: "STRING_VALUE",
+ * // State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED",
* // StateReason: "STRING_VALUE",
* // EventSourceArn: "STRING_VALUE",
* // Destination: { // ReplayDestination
diff --git a/clients/client-cloudwatch-events/src/commands/DescribeRuleCommand.ts b/clients/client-cloudwatch-events/src/commands/DescribeRuleCommand.ts
index 3bd82dd04148..cf3abe0a35c1 100644
--- a/clients/client-cloudwatch-events/src/commands/DescribeRuleCommand.ts
+++ b/clients/client-cloudwatch-events/src/commands/DescribeRuleCommand.ts
@@ -56,7 +56,7 @@ export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __Metad
* // Arn: "STRING_VALUE",
* // EventPattern: "STRING_VALUE",
* // ScheduleExpression: "STRING_VALUE",
- * // State: "STRING_VALUE",
+ * // State: "ENABLED" || "DISABLED",
* // Description: "STRING_VALUE",
* // RoleArn: "STRING_VALUE",
* // ManagedBy: "STRING_VALUE",
diff --git a/clients/client-cloudwatch-events/src/commands/DisableRuleCommand.ts b/clients/client-cloudwatch-events/src/commands/DisableRuleCommand.ts
index f674d82e353f..29bb56e5bafc 100644
--- a/clients/client-cloudwatch-events/src/commands/DisableRuleCommand.ts
+++ b/clients/client-cloudwatch-events/src/commands/DisableRuleCommand.ts
@@ -38,7 +38,6 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {}
* @public
*
Disables the specified rule. A disabled rule won't match any events, and won't * self-trigger if it has a schedule expression.
- * *When you disable a rule, incoming events might continue to match to the disabled rule. * Allow a short period of time for changes to take effect.
* @example diff --git a/clients/client-cloudwatch-events/src/commands/EnableRuleCommand.ts b/clients/client-cloudwatch-events/src/commands/EnableRuleCommand.ts index 69a1de229770..fdd1cb99201f 100644 --- a/clients/client-cloudwatch-events/src/commands/EnableRuleCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/EnableRuleCommand.ts @@ -37,7 +37,6 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {} /** * @public *Enables the specified rule. If the rule does not exist, the operation fails.
- * *When you enable a rule, incoming events might not immediately start matching to a newly * enabled rule. Allow a short period of time for changes to take effect.
* @example diff --git a/clients/client-cloudwatch-events/src/commands/ListApiDestinationsCommand.ts b/clients/client-cloudwatch-events/src/commands/ListApiDestinationsCommand.ts index c8d59059ae6f..ffdbd6194bb0 100644 --- a/clients/client-cloudwatch-events/src/commands/ListApiDestinationsCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListApiDestinationsCommand.ts @@ -56,10 +56,10 @@ export interface ListApiDestinationsCommandOutput extends ListApiDestinationsRes * // { // ApiDestination * // ApiDestinationArn: "STRING_VALUE", * // Name: "STRING_VALUE", - * // ApiDestinationState: "STRING_VALUE", + * // ApiDestinationState: "ACTIVE" || "INACTIVE", * // ConnectionArn: "STRING_VALUE", * // InvocationEndpoint: "STRING_VALUE", - * // HttpMethod: "STRING_VALUE", + * // HttpMethod: "POST" || "GET" || "HEAD" || "OPTIONS" || "PUT" || "PATCH" || "DELETE", * // InvocationRateLimitPerSecond: Number("int"), * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), diff --git a/clients/client-cloudwatch-events/src/commands/ListArchivesCommand.ts b/clients/client-cloudwatch-events/src/commands/ListArchivesCommand.ts index 0b1c56347a5a..ac453e19f9a4 100644 --- a/clients/client-cloudwatch-events/src/commands/ListArchivesCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListArchivesCommand.ts @@ -47,7 +47,7 @@ export interface ListArchivesCommandOutput extends ListArchivesResponse, __Metad * const input = { // ListArchivesRequest * NamePrefix: "STRING_VALUE", * EventSourceArn: "STRING_VALUE", - * State: "STRING_VALUE", + * State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED", * NextToken: "STRING_VALUE", * Limit: Number("int"), * }; @@ -58,7 +58,7 @@ export interface ListArchivesCommandOutput extends ListArchivesResponse, __Metad * // { // Archive * // ArchiveName: "STRING_VALUE", * // EventSourceArn: "STRING_VALUE", - * // State: "STRING_VALUE", + * // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED", * // StateReason: "STRING_VALUE", * // RetentionDays: Number("int"), * // SizeBytes: Number("long"), diff --git a/clients/client-cloudwatch-events/src/commands/ListConnectionsCommand.ts b/clients/client-cloudwatch-events/src/commands/ListConnectionsCommand.ts index b544e9b52438..36e92e14eed6 100644 --- a/clients/client-cloudwatch-events/src/commands/ListConnectionsCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListConnectionsCommand.ts @@ -45,7 +45,7 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _ * const client = new CloudWatchEventsClient(config); * const input = { // ListConnectionsRequest * NamePrefix: "STRING_VALUE", - * ConnectionState: "STRING_VALUE", + * ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING", * NextToken: "STRING_VALUE", * Limit: Number("int"), * }; @@ -56,9 +56,9 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _ * // { // Connection * // ConnectionArn: "STRING_VALUE", * // Name: "STRING_VALUE", - * // ConnectionState: "STRING_VALUE", + * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING", * // StateReason: "STRING_VALUE", - * // AuthorizationType: "STRING_VALUE", + * // AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY", * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), * // LastAuthorizedTime: new Date("TIMESTAMP"), diff --git a/clients/client-cloudwatch-events/src/commands/ListEventSourcesCommand.ts b/clients/client-cloudwatch-events/src/commands/ListEventSourcesCommand.ts index c2b1d98a3adc..7ac787a73710 100644 --- a/clients/client-cloudwatch-events/src/commands/ListEventSourcesCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListEventSourcesCommand.ts @@ -59,7 +59,7 @@ export interface ListEventSourcesCommandOutput extends ListEventSourcesResponse, * // CreationTime: new Date("TIMESTAMP"), * // ExpirationTime: new Date("TIMESTAMP"), * // Name: "STRING_VALUE", - * // State: "STRING_VALUE", + * // State: "PENDING" || "ACTIVE" || "DELETED", * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-cloudwatch-events/src/commands/ListPartnerEventSourceAccountsCommand.ts b/clients/client-cloudwatch-events/src/commands/ListPartnerEventSourceAccountsCommand.ts index 8753a72f9770..12b9949d50e9 100644 --- a/clients/client-cloudwatch-events/src/commands/ListPartnerEventSourceAccountsCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListPartnerEventSourceAccountsCommand.ts @@ -63,7 +63,7 @@ export interface ListPartnerEventSourceAccountsCommandOutput * // Account: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // ExpirationTime: new Date("TIMESTAMP"), - * // State: "STRING_VALUE", + * // State: "PENDING" || "ACTIVE" || "DELETED", * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-cloudwatch-events/src/commands/ListReplaysCommand.ts b/clients/client-cloudwatch-events/src/commands/ListReplaysCommand.ts index 2775037fb1d6..a4973768eb17 100644 --- a/clients/client-cloudwatch-events/src/commands/ListReplaysCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListReplaysCommand.ts @@ -46,7 +46,7 @@ export interface ListReplaysCommandOutput extends ListReplaysResponse, __Metadat * const client = new CloudWatchEventsClient(config); * const input = { // ListReplaysRequest * NamePrefix: "STRING_VALUE", - * State: "STRING_VALUE", + * State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED", * EventSourceArn: "STRING_VALUE", * NextToken: "STRING_VALUE", * Limit: Number("int"), @@ -58,7 +58,7 @@ export interface ListReplaysCommandOutput extends ListReplaysResponse, __Metadat * // { // Replay * // ReplayName: "STRING_VALUE", * // EventSourceArn: "STRING_VALUE", - * // State: "STRING_VALUE", + * // State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED", * // StateReason: "STRING_VALUE", * // EventStartTime: new Date("TIMESTAMP"), * // EventEndTime: new Date("TIMESTAMP"), diff --git a/clients/client-cloudwatch-events/src/commands/ListRulesCommand.ts b/clients/client-cloudwatch-events/src/commands/ListRulesCommand.ts index 2c7f5d128fc2..31521f6ccb34 100644 --- a/clients/client-cloudwatch-events/src/commands/ListRulesCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListRulesCommand.ts @@ -38,7 +38,6 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea * @public *Lists your Amazon EventBridge rules. You can either list all the rules or you can provide * a prefix to match to the rule names.
- * *ListRules does not list the targets of a rule. To see the targets associated with a rule, * use ListTargetsByRule.
* @example @@ -61,7 +60,7 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea * // Name: "STRING_VALUE", * // Arn: "STRING_VALUE", * // EventPattern: "STRING_VALUE", - * // State: "STRING_VALUE", + * // State: "ENABLED" || "DISABLED", * // Description: "STRING_VALUE", * // ScheduleExpression: "STRING_VALUE", * // RoleArn: "STRING_VALUE", diff --git a/clients/client-cloudwatch-events/src/commands/ListTargetsByRuleCommand.ts b/clients/client-cloudwatch-events/src/commands/ListTargetsByRuleCommand.ts index 3aadd9db8df6..95545dbeb9f9 100644 --- a/clients/client-cloudwatch-events/src/commands/ListTargetsByRuleCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/ListTargetsByRuleCommand.ts @@ -81,7 +81,7 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons * // EcsParameters: { // EcsParameters * // TaskDefinitionArn: "STRING_VALUE", // required * // TaskCount: Number("int"), - * // LaunchType: "STRING_VALUE", + * // LaunchType: "EC2" || "FARGATE" || "EXTERNAL", * // NetworkConfiguration: { // NetworkConfiguration * // awsvpcConfiguration: { // AwsVpcConfiguration * // Subnets: [ // StringList // required @@ -90,7 +90,7 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons * // SecurityGroups: [ * // "STRING_VALUE", * // ], - * // AssignPublicIp: "STRING_VALUE", + * // AssignPublicIp: "ENABLED" || "DISABLED", * // }, * // }, * // PlatformVersion: "STRING_VALUE", @@ -106,17 +106,17 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons * // EnableExecuteCommand: true || false, * // PlacementConstraints: [ // PlacementConstraints * // { // PlacementConstraint - * // type: "STRING_VALUE", + * // type: "distinctInstance" || "memberOf", * // expression: "STRING_VALUE", * // }, * // ], * // PlacementStrategy: [ // PlacementStrategies * // { // PlacementStrategy - * // type: "STRING_VALUE", + * // type: "random" || "spread" || "binpack", * // field: "STRING_VALUE", * // }, * // ], - * // PropagateTags: "STRING_VALUE", + * // PropagateTags: "TASK_DEFINITION", * // ReferenceId: "STRING_VALUE", * // Tags: [ // TagList * // { // Tag diff --git a/clients/client-cloudwatch-events/src/commands/PutPermissionCommand.ts b/clients/client-cloudwatch-events/src/commands/PutPermissionCommand.ts index d93e91a97e62..72e6fa4d9c8e 100644 --- a/clients/client-cloudwatch-events/src/commands/PutPermissionCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/PutPermissionCommand.ts @@ -42,19 +42,16 @@ export interface PutPermissionCommandOutput extends __MetadataBearer {} * account. *For another account to send events to your account, that external account must have an * EventBridge rule with your account's event bus as a target.
- * *To enable multiple Amazon Web Services accounts to put events to your event bus, run
* PutPermission
once for each of these accounts. Or, if all the accounts are
* members of the same Amazon Web Services organization, you can run PutPermission
once specifying
* Principal
as "*" and specifying the Amazon Web Services organization ID in
* Condition
, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must
* specify a RoleArn
with proper permissions when they use PutTarget
to
* add your account's event bus as a target. For more information, see Sending and
* Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User
* Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cloudwatch-events/src/commands/PutRuleCommand.ts b/clients/client-cloudwatch-events/src/commands/PutRuleCommand.ts index 04e32659176a..07aafdf72d0a 100644 --- a/clients/client-cloudwatch-events/src/commands/PutRuleCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/PutRuleCommand.ts @@ -38,26 +38,21 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer * @public *Creates or updates the specified rule. Rules are enabled by default, or based on value of * the state. You can disable a rule using DisableRule.
- * *A single rule watches for events from a single event bus. Events generated by Amazon Web Services services * go to your account's default event bus. Events generated by SaaS partner services or * applications go to the matching partner event bus. If you have custom applications or * services, you can specify whether their events go to your default event bus or a custom event * bus that you have created. For more information, see CreateEventBus.
- * *If you are updating an existing rule, the rule is replaced with what you specify in this
* PutRule
command. If you omit arguments in PutRule
, the old values
* for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to * new or updated rules. Allow a short period of time for changes to take effect.
- * *A rule must contain at least an EventPattern or ScheduleExpression. Rules with * EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions * self-trigger based on the given schedule. A rule can have both an EventPattern and a * ScheduleExpression, in which case the rule triggers on matching events as well as on a * schedule.
- * *When you initially create a rule, you can optionally assign one or more tags to the rule.
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions, by granting a user permission to access or change only rules with certain tag
@@ -65,12 +60,10 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer
* events:PutRule
and events:TagResource
permissions.
If you are updating an existing rule, any tags you specify in the PutRule
* operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). * However, EventBridge uses an exact match in event patterns and rules. Be sure to use the * correct ARN characters when creating event patterns so that they match the ARN syntax in the * event you want to match.
- * *In EventBridge, it is possible to create rules that lead to infinite loops, where a rule * is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, * and trigger software to change them to the desired state. If the rule is not written @@ -93,7 +86,7 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer * Name: "STRING_VALUE", // required * ScheduleExpression: "STRING_VALUE", * EventPattern: "STRING_VALUE", - * State: "STRING_VALUE", + * State: "ENABLED" || "DISABLED", * Description: "STRING_VALUE", * RoleArn: "STRING_VALUE", * Tags: [ // TagList diff --git a/clients/client-cloudwatch-events/src/commands/PutTargetsCommand.ts b/clients/client-cloudwatch-events/src/commands/PutTargetsCommand.ts index c45760272480..c78452fce527 100644 --- a/clients/client-cloudwatch-events/src/commands/PutTargetsCommand.ts +++ b/clients/client-cloudwatch-events/src/commands/PutTargetsCommand.ts @@ -40,7 +40,6 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB * already associated with the rule.
*Targets are the resources that are invoked when a rule is triggered.
*You can configure the following as targets for Events:
- * *@@ -120,17 +119,14 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB *
Step Functions state machines
*Creating rules with built-in targets is supported only in the Management Console. The + *
Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
* built-in targets are EC2 CreateSnapshot API call
, EC2 RebootInstances API
* call
, EC2 StopInstances API call
, and EC2 TerminateInstances API
* call
.
For some target types, PutTargets
provides target-specific parameters. If the
* target is a Kinesis data stream, you can optionally specify which shard the event goes to by
* using the KinesisParameters
argument. To invoke a command on multiple EC2
* instances with one rule, you can use the RunCommandParameters
field.
To be able to make API calls against the resources that you own, Amazon EventBridge
* needs the appropriate permissions. For Lambda and Amazon SNS
* resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams,
@@ -138,7 +134,6 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
* IAM roles that you specify in the RoleARN
argument in PutTargets
.
* For more information, see Authentication
* and Access Control in the Amazon EventBridge User Guide.
If another Amazon Web Services account is in the same region and has granted you permission (using
* PutPermission
), you can send events to that account. Set that account's event
* bus as a target of the rules in your account. To send the matched events to the other account,
@@ -147,28 +142,23 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
* charged for each sent event. Each event sent to another account is charged as a custom event.
* The account receiving the event is not charged. For more information, see Amazon EventBridge
* Pricing.
* Input
, InputPath
, and InputTransformer
are not
* available with PutTarget
if the target is an event bus of a different Amazon Web Services
* account.
If you are setting the event bus of another account as the target, and that account
* granted permission to your account through an organization instead of directly by the account
* ID, then you must specify a RoleArn
with proper permissions in the
* Target
structure. For more information, see Sending and
* Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User
* Guide.
For more information about enabling cross-account events, see PutPermission.
- * ** Input, InputPath, and * InputTransformer are mutually exclusive and optional * parameters of a target. When a rule is triggered due to a matched event:
- * *If none of the following arguments are specified for a target, then the entire event @@ -191,14 +181,11 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB * specify as the input to the target.
*When you specify InputPath
or InputTransformer
, you must use
* JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated * targets might not be immediately invoked. Allow a short period of time for changes to take * effect.
- * *This action can partially fail if too many requests are made at the same time. If that
* happens, FailedEntryCount
is non-zero in the response and each entry in
* FailedEntries
provides the ID of the failed target and the error code.
Removes the specified targets from the specified rule. When the rule is triggered, those * targets are no longer be invoked.
- * *When you remove a target, when the associated rule triggers, removed targets might * continue to be invoked. Allow a short period of time for changes to take effect.
- * *This action can partially fail if too many requests are made at the same time. If that
* happens, FailedEntryCount
is non-zero in the response and each entry in
* FailedEntries
provides the ID of the failed target and the error code.
InputPathsMap
to customize the data sent to the target. Enclose each
* InputPathsMaps
value in brackets: <value> The
* InputTemplate must be valid JSON.
- *
* If InputTemplate
is a JSON object (surrounded by curly braces), the following
* restrictions apply:
Targets are the resources to be invoked when a rule is triggered. For a complete list of * services and resources that can be set as a target, see PutTargets.
- * *If you are setting the event bus of another account as the target, and that account
* granted permission to your account through an organization instead of directly by the account
* ID, then you must specify a RoleArn
with proper permissions in the
@@ -3879,7 +3877,6 @@ export interface PutPermissionRequest {
* @public
*
The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event * bus. Specify "*" to permit any account to put events to your default event bus.
- * *If you specify "*" without specifying Condition
, avoid creating rules that
* may match undesirable events. To create more secure rules, make sure that the event pattern
* for each rule contains an account
field with a specific account ID from which to
@@ -3905,7 +3902,6 @@ export interface PutPermissionRequest {
*
If you specify Condition
with an Amazon Web Services organization ID, and specify "*" as the
* value for Principal
, you grant permission to all the accounts in the named
* organization.
The Condition
is a JSON string which must contain Type
,
* Key
, and Value
fields.
The reason that the replay is in the current state.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#CapacityProvider": { @@ -3126,22 +2039,26 @@ } }, "com.amazonaws.cloudwatchevents#ConnectionAuthorizationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BASIC", - "name": "BASIC" - }, - { - "value": "OAUTH_CLIENT_CREDENTIALS", - "name": "OAUTH_CLIENT_CREDENTIALS" - }, - { - "value": "API_KEY", - "name": "API_KEY" + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH_CLIENT_CREDENTIALS" + } + }, + "API_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_KEY" } - ] + } } }, "com.amazonaws.cloudwatchevents#ConnectionBasicAuthResponseParameters": { @@ -3297,22 +2214,26 @@ } }, "com.amazonaws.cloudwatchevents#ConnectionOAuthHttpMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GET", - "name": "GET" - }, - { - "value": "POST", - "name": "POST" - }, - { - "value": "PUT", - "name": "PUT" + "type": "enum", + "members": { + "GET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET" + } + }, + "POST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST" } - ] + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + } } }, "com.amazonaws.cloudwatchevents#ConnectionOAuthResponseParameters": { @@ -3393,38 +2314,50 @@ } }, "com.amazonaws.cloudwatchevents#ConnectionState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "AUTHORIZED", - "name": "AUTHORIZED" - }, - { - "value": "DEAUTHORIZED", - "name": "DEAUTHORIZED" - }, - { - "value": "AUTHORIZING", - "name": "AUTHORIZING" - }, - { - "value": "DEAUTHORIZING", - "name": "DEAUTHORIZING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZED" + } + }, + "DEAUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEAUTHORIZED" + } + }, + "AUTHORIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZING" + } + }, + "DEAUTHORIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEAUTHORIZING" } - ] + } } }, "com.amazonaws.cloudwatchevents#ConnectionStateReason": { @@ -3506,6 +2439,9 @@ "smithy.api#documentation": "The maximum number of requests per second to send to the HTTP invocation endpoint.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#CreateApiDestinationResponse": { @@ -3535,6 +2471,9 @@ "smithy.api#documentation": "A time stamp indicating the time that the API destination was last modified.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#CreateArchive": { @@ -3604,6 +2543,9 @@ "smithy.api#documentation": "The number of days to retain events for. Default value is 0. If set to 0, events are\n retained indefinitely
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#CreateArchiveResponse": { @@ -3633,6 +2575,9 @@ "smithy.api#documentation": "The time at which the archive was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#CreateConnection": { @@ -3821,6 +2766,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#CreateConnectionResponse": { @@ -3850,6 +2798,9 @@ "smithy.api#documentation": "A time stamp for the time that the connection was last updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#CreateEventBus": { @@ -3909,6 +2860,9 @@ "smithy.api#documentation": "Tags to associate with the event bus.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#CreateEventBusResponse": { @@ -3920,6 +2874,9 @@ "smithy.api#documentation": "The ARN of the new event bus.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#CreatePartnerEventSource": { @@ -3968,6 +2925,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#CreatePartnerEventSourceResponse": { @@ -3979,6 +2939,9 @@ "smithy.api#documentation": "The ARN of the partner event source.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#CreatedBy": { @@ -4047,6 +3010,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DeadLetterConfig": { @@ -4096,6 +3062,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DeauthorizeConnectionResponse": { @@ -4131,6 +3100,9 @@ "smithy.api#documentation": "A time stamp for the time that the connection was last authorized.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DeleteApiDestination": { @@ -4166,11 +3138,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DeleteApiDestinationResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloudwatchevents#DeleteArchive": { "type": "operation", @@ -4205,11 +3183,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DeleteArchiveResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloudwatchevents#DeleteConnection": { "type": "operation", @@ -4244,6 +3228,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DeleteConnectionResponse": { @@ -4279,6 +3266,9 @@ "smithy.api#documentation": "A time stamp for the time that the connection was last authorized before it wa\n deleted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DeleteEventBus": { @@ -4311,6 +3301,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DeletePartnerEventSource": { @@ -4353,6 +3346,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DeleteRule": { @@ -4378,7 +3374,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified rule.
\nBefore you can delete the rule, you must remove all targets, using RemoveTargets.
\n\nWhen you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.
\n\nIf you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException
is\n returned.
Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These\n rules are created by those other Amazon Web Services services to support functionality in those services. You\n can delete these rules using the Force
option, but you should do so only if you\n are sure the other service is not still using that rule.
Deletes the specified rule.
\nBefore you can delete the rule, you must remove all targets, using RemoveTargets.
\nWhen you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.
\nIf you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException
is\n returned.
Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These\n rules are created by those other Amazon Web Services services to support functionality in those services. You\n can delete these rules using the Force
option, but you should do so only if you\n are sure the other service is not still using that rule.
If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force
as True
to delete the rule. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule
or ListRules
and checking the ManagedBy
\n field of the response.
A time stamp for the time that the API destination was last modified.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DescribeArchive": { @@ -4536,6 +3541,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DescribeArchiveResponse": { @@ -4609,6 +3617,9 @@ "smithy.api#documentation": "The time at which the archive was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DescribeConnection": { @@ -4641,6 +3652,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DescribeConnectionResponse": { @@ -4712,6 +3726,9 @@ "smithy.api#documentation": "A time stamp for the time that the connection was last authorized.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DescribeEventBus": { @@ -4743,6 +3760,9 @@ "smithy.api#documentation": "The name or ARN of the event bus to show details for. If you omit this, the default event\n bus is displayed.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DescribeEventBusResponse": { @@ -4766,6 +3786,9 @@ "smithy.api#documentation": "The policy that enables the external account to send events to your account.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DescribeEventSource": { @@ -4801,6 +3824,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DescribeEventSourceResponse": { @@ -4842,6 +3868,9 @@ "smithy.api#documentation": "The state of the event source. If it is ACTIVE, you have already created a matching event\n bus for this event source, and that event bus is active. If it is PENDING, either you haven't\n yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have\n created a matching event bus, but the event source has since been deleted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DescribePartnerEventSource": { @@ -4877,6 +3906,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DescribePartnerEventSourceResponse": { @@ -4894,6 +3926,9 @@ "smithy.api#documentation": "The name of the event source.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DescribeReplay": { @@ -4926,6 +3961,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DescribeReplayResponse": { @@ -5003,6 +4041,9 @@ "smithy.api#documentation": "A time stamp for the time that the replay stopped.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#DescribeRule": { @@ -5041,6 +4082,9 @@ "smithy.api#documentation": "The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#DescribeRuleResponse": { @@ -5106,6 +4150,9 @@ "smithy.api#documentation": "The account ID of the user that created the rule. If you use PutRule
to put a\n rule on an event bus in another account, the other account is the owner of the rule, and the\n rule ARN includes the account ID for that account. However, the value for\n CreatedBy
is the account ID as the account that created the rule in the other\n account.
Disables the specified rule. A disabled rule won't match any events, and won't\n self-trigger if it has a schedule expression.
\n\nWhen you disable a rule, incoming events might continue to match to the disabled rule.\n Allow a short period of time for changes to take effect.
" + "smithy.api#documentation": "Disables the specified rule. A disabled rule won't match any events, and won't\n self-trigger if it has a schedule expression.
\nWhen you disable a rule, incoming events might continue to match to the disabled rule.\n Allow a short period of time for changes to take effect.
" } }, "com.amazonaws.cloudwatchevents#DisableRuleRequest": { @@ -5150,6 +4197,9 @@ "smithy.api#documentation": "The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#EcsParameters": { @@ -5270,7 +4320,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables the specified rule. If the rule does not exist, the operation fails.
\n\nWhen you enable a rule, incoming events might not immediately start matching to a newly\n enabled rule. Allow a short period of time for changes to take effect.
" + "smithy.api#documentation": "Enables the specified rule. If the rule does not exist, the operation fails.
\nWhen you enable a rule, incoming events might not immediately start matching to a newly\n enabled rule. Allow a short period of time for changes to take effect.
" } }, "com.amazonaws.cloudwatchevents#EnableRuleRequest": { @@ -5289,6 +4339,9 @@ "smithy.api#documentation": "The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ErrorCode": { @@ -5435,22 +4488,26 @@ } }, "com.amazonaws.cloudwatchevents#EventSourceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETED", - "name": "DELETED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" } - ] + } } }, "com.amazonaws.cloudwatchevents#EventTime": { @@ -5545,7 +4602,7 @@ "InputTemplate": { "target": "com.amazonaws.cloudwatchevents#TransformerInput", "traits": { - "smithy.api#documentation": "Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap
to customize the data sent to the target. Enclose each\n InputPathsMaps
value in brackets: <value> The\n InputTemplate must be valid JSON.
If InputTemplate
is a JSON object (surrounded by curly braces), the following\n restrictions apply:
The placeholder cannot be used as an object key.
\nThe following example shows the syntax for using InputPathsMap
and\n InputTemplate
.
\n \"InputTransformer\":
\n
\n {
\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},
\n
\n \"InputTemplate\": \"
\n
\n }
\n
To have the InputTemplate
include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:
\n \"InputTransformer\":
\n
\n {
\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},
\n
\n \"InputTemplate\": \"
\n
\n }
\n
The InputTemplate
can also be valid JSON with varibles in quotes or out, as\n in the following example:
\n \"InputTransformer\":
\n
\n {
\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},
\n
\n \"InputTemplate\": '{\"myInstance\":
\n
\n }
\n
Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap
to customize the data sent to the target. Enclose each\n InputPathsMaps
value in brackets: <value> The\n InputTemplate must be valid JSON.
If InputTemplate
is a JSON object (surrounded by curly braces), the following\n restrictions apply:
The placeholder cannot be used as an object key.
\nThe following example shows the syntax for using InputPathsMap
and\n InputTemplate
.
\n \"InputTransformer\":
\n
\n {
\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},
\n
\n \"InputTemplate\": \"
\n
\n }
\n
To have the InputTemplate
include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:
\n \"InputTransformer\":
\n
\n {
\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},
\n
\n \"InputTemplate\": \"
\n
\n }
\n
The InputTemplate
can also be valid JSON with varibles in quotes or out, as\n in the following example:
\n \"InputTransformer\":
\n
\n {
\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},
\n
\n \"InputTemplate\": '{\"myInstance\":
\n
\n }
\n
The maximum number of API destinations to include in the response.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListApiDestinationsResponse": { @@ -5730,6 +4794,9 @@ "smithy.api#documentation": "A token you can use in a subsequent request to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListArchives": { @@ -5785,6 +4852,9 @@ "smithy.api#documentation": "The maximum number of results to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListArchivesResponse": { @@ -5802,6 +4872,9 @@ "smithy.api#documentation": "The token returned by a previous call to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListConnections": { @@ -5848,6 +4921,9 @@ "smithy.api#documentation": "The maximum number of connections to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListConnectionsResponse": { @@ -5865,6 +4941,9 @@ "smithy.api#documentation": "A token you can use in a subsequent request to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListEventBuses": { @@ -5905,6 +4984,9 @@ "smithy.api#documentation": "Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the next set\n of results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListEventBusesResponse": { @@ -5922,6 +5004,9 @@ "smithy.api#documentation": "A token you can use in a subsequent operation to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListEventSources": { @@ -5965,6 +5050,9 @@ "smithy.api#documentation": "Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the next set\n of results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListEventSourcesResponse": { @@ -5982,6 +5070,9 @@ "smithy.api#documentation": "A token you can use in a subsequent operation to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListPartnerEventSourceAccounts": { @@ -6029,6 +5120,9 @@ "smithy.api#documentation": "Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the next set\n of results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListPartnerEventSourceAccountsResponse": { @@ -6046,6 +5140,9 @@ "smithy.api#documentation": "A token you can use in a subsequent operation to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListPartnerEventSources": { @@ -6090,6 +5187,9 @@ "smithy.api#documentation": "pecifying this limits the number of results returned by this operation. The operation also\n returns a NextToken which you can use in a subsequent operation to retrieve the next set of\n results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListPartnerEventSourcesResponse": { @@ -6107,6 +5207,9 @@ "smithy.api#documentation": "A token you can use in a subsequent operation to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListReplays": { @@ -6159,6 +5262,9 @@ "smithy.api#documentation": "The maximum number of replays to retrieve.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListReplaysResponse": { @@ -6176,6 +5282,9 @@ "smithy.api#documentation": "The token returned by a previous call to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListRuleNamesByTarget": { @@ -6226,6 +5335,9 @@ "smithy.api#documentation": "The maximum number of results to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListRuleNamesByTargetResponse": { @@ -6243,6 +5355,9 @@ "smithy.api#documentation": "Indicates whether there are additional results to retrieve. If there are no more results,\n the value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListRules": { @@ -6262,7 +5377,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.
\n\nListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.
" + "smithy.api#documentation": "Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.
\nListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.
" } }, "com.amazonaws.cloudwatchevents#ListRulesRequest": { @@ -6292,6 +5407,9 @@ "smithy.api#documentation": "The maximum number of results to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListRulesResponse": { @@ -6309,6 +5427,9 @@ "smithy.api#documentation": "Indicates whether there are additional results to retrieve. If there are no more results,\n the value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListTagsForResource": { @@ -6341,6 +5462,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListTagsForResourceResponse": { @@ -6352,6 +5476,9 @@ "smithy.api#documentation": "The list of tag keys and values associated with the resource you specified
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#ListTargetsByRule": { @@ -6402,6 +5529,9 @@ "smithy.api#documentation": "The maximum number of results to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#ListTargetsByRuleResponse": { @@ -6419,6 +5549,9 @@ "smithy.api#documentation": "Indicates whether there are additional results to retrieve. If there are no more results,\n the value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#Long": { @@ -6640,18 +5773,20 @@ } }, "com.amazonaws.cloudwatchevents#PlacementConstraintType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "distinctInstance", - "name": "DISTINCT_INSTANCE" - }, - { - "value": "memberOf", - "name": "MEMBER_OF" + "type": "enum", + "members": { + "DISTINCT_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "distinctInstance" } - ] + }, + "MEMBER_OF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "memberOf" + } + } } }, "com.amazonaws.cloudwatchevents#PlacementConstraints": { @@ -6708,22 +5843,26 @@ } }, "com.amazonaws.cloudwatchevents#PlacementStrategyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "random", - "name": "RANDOM" - }, - { - "value": "spread", - "name": "SPREAD" - }, - { - "value": "binpack", - "name": "BINPACK" + "type": "enum", + "members": { + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "random" + } + }, + "SPREAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spread" + } + }, + "BINPACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "binpack" } - ] + } } }, "com.amazonaws.cloudwatchevents#PolicyLengthExceededException": { @@ -6749,14 +5888,14 @@ } }, "com.amazonaws.cloudwatchevents#PropagateTags": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TASK_DEFINITION", - "name": "TASK_DEFINITION" + "type": "enum", + "members": { + "TASK_DEFINITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK_DEFINITION" } - ] + } } }, "com.amazonaws.cloudwatchevents#PutEvents": { @@ -6786,6 +5925,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#PutEventsRequestEntry": { @@ -6866,6 +6008,9 @@ "smithy.api#documentation": "The successfully and unsuccessfully ingested events results. If the ingestion was\n successful, the entry has the event ID in it. Otherwise, you can use the error code and error\n message to identify the problem with the entry.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#PutEventsResultEntry": { @@ -6930,6 +6075,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#PutPartnerEventsRequestEntry": { @@ -6998,6 +6146,9 @@ "smithy.api#documentation": "The list of events from this operation that were successfully written to the partner event\n bus.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#PutPartnerEventsResultEntry": { @@ -7058,7 +6209,7 @@ } ], "traits": { - "smithy.api#documentation": "Running PutPermission
permits the specified Amazon Web Services account or Amazon Web Services organization\n to put events to the specified event bus. Amazon EventBridge (CloudWatch\n Events) rules in your account are triggered by these events arriving to an event bus in your\n account.
For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.
\n\nTo enable multiple Amazon Web Services accounts to put events to your event bus, run\n PutPermission
once for each of these accounts. Or, if all the accounts are\n members of the same Amazon Web Services organization, you can run PutPermission
once specifying\n Principal
as \"*\" and specifying the Amazon Web Services organization ID in\n Condition
, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn
with proper permissions when they use PutTarget
to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
" + "smithy.api#documentation": "Running PutPermission
permits the specified Amazon Web Services account or Amazon Web Services organization\n to put events to the specified event bus. Amazon EventBridge (CloudWatch\n Events) rules in your account are triggered by these events arriving to an event bus in your\n account.
For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.
\nTo enable multiple Amazon Web Services accounts to put events to your event bus, run\n PutPermission
once for each of these accounts. Or, if all the accounts are\n members of the same Amazon Web Services organization, you can run PutPermission
once specifying\n Principal
as \"*\" and specifying the Amazon Web Services organization ID in\n Condition
, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn
with proper permissions when they use PutTarget
to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
" } }, "com.amazonaws.cloudwatchevents#PutPermissionRequest": { @@ -7079,7 +6230,7 @@ "Principal": { "target": "com.amazonaws.cloudwatchevents#Principal", "traits": { - "smithy.api#documentation": "The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event\n bus. Specify \"*\" to permit any account to put events to your default event bus.
\n\nIf you specify \"*\" without specifying Condition
, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account
field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.
The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event\n bus. Specify \"*\" to permit any account to put events to your default event bus.
\nIf you specify \"*\" without specifying Condition
, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account
field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.
This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain Amazon Web Services organization. For more information about\n Amazon Web Services Organizations, see What Is Amazon Web Services \n Organizations in the Amazon Web Services Organizations User Guide.
\nIf you specify Condition
with an Amazon Web Services organization ID, and specify \"*\" as the\n value for Principal
, you grant permission to all the accounts in the named\n organization.
The Condition
is a JSON string which must contain Type
,\n Key
, and Value
fields.
This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain Amazon Web Services organization. For more information about\n Amazon Web Services Organizations, see What Is Amazon Web Services \n Organizations in the Amazon Web Services Organizations User Guide.
\nIf you specify Condition
with an Amazon Web Services organization ID, and specify \"*\" as the\n value for Principal
, you grant permission to all the accounts in the named\n organization.
The Condition
is a JSON string which must contain Type
,\n Key
, and Value
fields.
A JSON string that describes the permission policy statement. You can include a\n Policy
parameter in the request instead of using the StatementId
,\n Action
, Principal
, or Condition
parameters.
Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.
\n\nA single rule watches for events from a single event bus. Events generated by Amazon Web Services services\n go to your account's default event bus. Events generated by SaaS partner services or\n applications go to the matching partner event bus. If you have custom applications or\n services, you can specify whether their events go to your default event bus or a custom event\n bus that you have created. For more information, see CreateEventBus.
\n\nIf you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule
command. If you omit arguments in PutRule
, the old values\n for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.
\n\nA rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.
\n\nWhen you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule
operation and assign tags, you must have both the\n events:PutRule
and events:TagResource
permissions.
If you are updating an existing rule, any tags you specify in the PutRule
\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.
\n\nIn EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.
\nTo prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.
\nAn infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.
" + "smithy.api#documentation": "Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.
\nA single rule watches for events from a single event bus. Events generated by Amazon Web Services services\n go to your account's default event bus. Events generated by SaaS partner services or\n applications go to the matching partner event bus. If you have custom applications or\n services, you can specify whether their events go to your default event bus or a custom event\n bus that you have created. For more information, see CreateEventBus.
\nIf you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule
command. If you omit arguments in PutRule
, the old values\n for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.
\nA rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.
\nWhen you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule
operation and assign tags, you must have both the\n events:PutRule
and events:TagResource
permissions.
If you are updating an existing rule, any tags you specify in the PutRule
\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.
\nIn EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.
\nTo prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.
\nAn infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.
" } }, "com.amazonaws.cloudwatchevents#PutRuleRequest": { @@ -7186,6 +6340,9 @@ "smithy.api#documentation": "The name or ARN of the event bus to associate with this rule. If you omit this, the\n default event bus is used.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#PutRuleResponse": { @@ -7197,6 +6354,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#PutTargets": { @@ -7225,7 +6385,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.
\nTargets are the resources that are invoked when a rule is triggered.
\nYou can configure the following as targets for Events:
\n\n\n API\n destination\n
\nAmazon API Gateway REST API endpoints
\nAPI Gateway
\nBatch job queue
\nCloudWatch Logs group
\nCodeBuild project
\nCodePipeline
\nAmazon EC2 CreateSnapshot
API call
Amazon EC2 RebootInstances
API call
Amazon EC2 StopInstances
API call
Amazon EC2 TerminateInstances
API call
Amazon ECS tasks
\nEvent bus in a different Amazon Web Services account or Region.
\nYou can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon)\n us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
\nFirehose delivery stream (Kinesis Data Firehose)
\nInspector assessment template (Amazon Inspector)
\nKinesis stream (Kinesis Data Stream)
\nLambda function
\nRedshift clusters (Data API statement execution)
\nAmazon SNS topic
\nAmazon SQS queues (includes FIFO queues
\nSSM Automation
\nSSM OpsItem
\nSSM Run Command
\nStep Functions state machines
\nCreating rules with built-in targets is supported only in the Management Console. The\n built-in targets are EC2 CreateSnapshot API call
, EC2 RebootInstances API\n call
, EC2 StopInstances API call
, and EC2 TerminateInstances API\n call
.
For some target types, PutTargets
provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters
argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters
field.
To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN
argument in PutTargets
.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.
If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission
), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn
value when you run\n PutTargets
. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.
\n Input
, InputPath
, and InputTransformer
are not\n available with PutTarget
if the target is an event bus of a different Amazon Web Services \n account.
If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn
with proper permissions in the\n Target
structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
For more information about enabling cross-account events, see PutPermission.
\n\n\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:
\n\nIf none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).
\nIf Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.
\nIf InputPath is specified in the form of JSONPath\n (for example, $.detail
), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).
If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.
\nWhen you specify InputPath
or InputTransformer
, you must use\n JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.
\n\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount
is non-zero in the response and each entry in\n FailedEntries
provides the ID of the failed target and the error code.
Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.
\nTargets are the resources that are invoked when a rule is triggered.
\nYou can configure the following as targets for Events:
\n\n API\n destination\n
\nAmazon API Gateway REST API endpoints
\nAPI Gateway
\nBatch job queue
\nCloudWatch Logs group
\nCodeBuild project
\nCodePipeline
\nAmazon EC2 CreateSnapshot
API call
Amazon EC2 RebootInstances
API call
Amazon EC2 StopInstances
API call
Amazon EC2 TerminateInstances
API call
Amazon ECS tasks
\nEvent bus in a different Amazon Web Services account or Region.
\nYou can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon)\n us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
\nFirehose delivery stream (Kinesis Data Firehose)
\nInspector assessment template (Amazon Inspector)
\nKinesis stream (Kinesis Data Stream)
\nLambda function
\nRedshift clusters (Data API statement execution)
\nAmazon SNS topic
\nAmazon SQS queues (includes FIFO queues
\nSSM Automation
\nSSM OpsItem
\nSSM Run Command
\nStep Functions state machines
\nCreating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are EC2 CreateSnapshot API call
, EC2 RebootInstances API\n call
, EC2 StopInstances API call
, and EC2 TerminateInstances API\n call
.
For some target types, PutTargets
provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters
argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters
field.
To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN
argument in PutTargets
.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.
If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission
), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn
value when you run\n PutTargets
. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.
\n Input
, InputPath
, and InputTransformer
are not\n available with PutTarget
if the target is an event bus of a different Amazon Web Services \n account.
If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn
with proper permissions in the\n Target
structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
For more information about enabling cross-account events, see PutPermission.
\n\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:
\nIf none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).
\nIf Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.
\nIf InputPath is specified in the form of JSONPath\n (for example, $.detail
), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).
If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.
\nWhen you specify InputPath
or InputTransformer
, you must use\n JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.
\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount
is non-zero in the response and each entry in\n FailedEntries
provides the ID of the failed target and the error code.
The failed target entries.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#PutTargetsResultEntry": { @@ -7446,6 +6612,9 @@ "smithy.api#documentation": "The name of the event bus to revoke permissions for. If you omit this, the default event\n bus is used.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#RemoveTargets": { @@ -7471,7 +6640,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified targets from the specified rule. When the rule is triggered, those\n targets are no longer be invoked.
\n\nWhen you remove a target, when the associated rule triggers, removed targets might\n continue to be invoked. Allow a short period of time for changes to take effect.
\n\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount
is non-zero in the response and each entry in\n FailedEntries
provides the ID of the failed target and the error code.
Removes the specified targets from the specified rule. When the rule is triggered, those\n targets are no longer be invoked.
\nWhen you remove a target, when the associated rule triggers, removed targets might\n continue to be invoked. Allow a short period of time for changes to take effect.
\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount
is non-zero in the response and each entry in\n FailedEntries
provides the ID of the failed target and the error code.
If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force
as True
to remove targets. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule
or ListRules
and checking the ManagedBy
\n field of the response.
The failed target entries.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#RemoveTargetsResultEntry": { @@ -7682,34 +6857,44 @@ } }, "com.amazonaws.cloudwatchevents#ReplayState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "CANCELLING", - "name": "CANCELLING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "CANCELLED", - "name": "CANCELLED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.cloudwatchevents#ReplayStateReason": { @@ -7895,18 +7080,20 @@ } }, "com.amazonaws.cloudwatchevents#RuleState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" } - ] + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } } }, "com.amazonaws.cloudwatchevents#RunCommandParameters": { @@ -8171,6 +7358,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#StartReplayResponse": { @@ -8200,6 +7390,9 @@ "smithy.api#documentation": "The time at which the replay started.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#StatementId": { @@ -8316,11 +7509,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloudwatchevents#TagValue": { "type": "string", @@ -8434,7 +7633,7 @@ } }, "traits": { - "smithy.api#documentation": "Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.
\n\nIf you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn
with proper permissions in the\n Target
structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.
\nIf you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn
with proper permissions in the\n Target
structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
Indicates whether the event matches the event pattern.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#Timestamp": { @@ -8637,11 +7842,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloudwatchevents#UpdateApiDestination": { "type": "operation", @@ -8709,6 +7920,9 @@ "smithy.api#documentation": "The maximum number of invocations per second to send to the API destination.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#UpdateApiDestinationResponse": { @@ -8738,6 +7952,9 @@ "smithy.api#documentation": "A time stamp for the time that the API destination was last modified.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#UpdateArchive": { @@ -8797,6 +8014,9 @@ "smithy.api#documentation": "The number of days to retain events in the archive.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#UpdateArchiveResponse": { @@ -8826,6 +8046,9 @@ "smithy.api#documentation": "The time at which the archive was updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchevents#UpdateConnection": { @@ -9006,6 +8229,9 @@ "smithy.api#documentation": "The authorization parameters to use for the connection.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchevents#UpdateConnectionResponse": { @@ -9041,7 +8267,10 @@ "smithy.api#documentation": "A time stamp for the time that the connection was last authorized.
" } } + }, + "traits": { + "smithy.api#output": {} } } } -} \ No newline at end of file +}