Skip to content

Commit 6f8e057

Browse files
author
awstools
committed
feat(client-cloudwatch-events): Documentation updates for CloudWatch Events.
1 parent 58d1b48 commit 6f8e057

34 files changed

+1104
-1909
lines changed

‎clients/client-cloudwatch-events/src/commands/CancelReplayCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad
5050
* const response = await client.send(command);
5151
* // { // CancelReplayResponse
5252
* // ReplayArn: "STRING_VALUE",
53-
* // State: "STRING_VALUE",
53+
* // State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED",
5454
* // StateReason: "STRING_VALUE",
5555
* // };
5656
*

‎clients/client-cloudwatch-events/src/commands/CreateApiDestinationCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,14 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR
4949
* Description: "STRING_VALUE",
5050
* ConnectionArn: "STRING_VALUE", // required
5151
* InvocationEndpoint: "STRING_VALUE", // required
52-
* HttpMethod: "STRING_VALUE", // required
52+
* HttpMethod: "POST" || "GET" || "HEAD" || "OPTIONS" || "PUT" || "PATCH" || "DELETE", // required
5353
* InvocationRateLimitPerSecond: Number("int"),
5454
* };
5555
* const command = new CreateApiDestinationCommand(input);
5656
* const response = await client.send(command);
5757
* // { // CreateApiDestinationResponse
5858
* // ApiDestinationArn: "STRING_VALUE",
59-
* // ApiDestinationState: "STRING_VALUE",
59+
* // ApiDestinationState: "ACTIVE" || "INACTIVE",
6060
* // CreationTime: new Date("TIMESTAMP"),
6161
* // LastModifiedTime: new Date("TIMESTAMP"),
6262
* // };

‎clients/client-cloudwatch-events/src/commands/CreateArchiveCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met
5858
* const response = await client.send(command);
5959
* // { // CreateArchiveResponse
6060
* // ArchiveArn: "STRING_VALUE",
61-
* // State: "STRING_VALUE",
61+
* // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
6262
* // StateReason: "STRING_VALUE",
6363
* // CreationTime: new Date("TIMESTAMP"),
6464
* // };

‎clients/client-cloudwatch-events/src/commands/CreateConnectionCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
4747
* const input = { // CreateConnectionRequest
4848
* Name: "STRING_VALUE", // required
4949
* Description: "STRING_VALUE",
50-
* AuthorizationType: "STRING_VALUE", // required
50+
* AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY", // required
5151
* AuthParameters: { // CreateConnectionAuthRequestParameters
5252
* BasicAuthParameters: { // CreateConnectionBasicAuthRequestParameters
5353
* Username: "STRING_VALUE", // required
@@ -59,7 +59,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
5959
* ClientSecret: "STRING_VALUE", // required
6060
* },
6161
* AuthorizationEndpoint: "STRING_VALUE", // required
62-
* HttpMethod: "STRING_VALUE", // required
62+
* HttpMethod: "GET" || "POST" || "PUT", // required
6363
* OAuthHttpParameters: { // ConnectionHttpParameters
6464
* HeaderParameters: [ // ConnectionHeaderParametersList
6565
* { // ConnectionHeaderParameter
@@ -117,7 +117,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
117117
* const response = await client.send(command);
118118
* // { // CreateConnectionResponse
119119
* // ConnectionArn: "STRING_VALUE",
120-
* // ConnectionState: "STRING_VALUE",
120+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
121121
* // CreationTime: new Date("TIMESTAMP"),
122122
* // LastModifiedTime: new Date("TIMESTAMP"),
123123
* // };

‎clients/client-cloudwatch-events/src/commands/DeauthorizeConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio
5151
* const response = await client.send(command);
5252
* // { // DeauthorizeConnectionResponse
5353
* // ConnectionArn: "STRING_VALUE",
54-
* // ConnectionState: "STRING_VALUE",
54+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
5555
* // CreationTime: new Date("TIMESTAMP"),
5656
* // LastModifiedTime: new Date("TIMESTAMP"),
5757
* // LastAuthorizedTime: new Date("TIMESTAMP"),

‎clients/client-cloudwatch-events/src/commands/DeleteConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse,
5050
* const response = await client.send(command);
5151
* // { // DeleteConnectionResponse
5252
* // ConnectionArn: "STRING_VALUE",
53-
* // ConnectionState: "STRING_VALUE",
53+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
5454
* // CreationTime: new Date("TIMESTAMP"),
5555
* // LastModifiedTime: new Date("TIMESTAMP"),
5656
* // LastAuthorizedTime: new Date("TIMESTAMP"),

‎clients/client-cloudwatch-events/src/commands/DeleteRuleCommand.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,11 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {}
3838
* @public
3939
* <p>Deletes the specified rule.</p>
4040
* <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html">RemoveTargets</a>.</p>
41-
*
4241
* <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
4342
* a short period of time for changes to take effect.</p>
44-
*
4543
* <p>If you call delete rule multiple times for the same rule, all calls will succeed. When you
4644
* call delete rule for a non-existent custom eventbus, <code>ResourceNotFoundException</code> is
4745
* returned.</p>
48-
*
4946
* <p>Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These
5047
* rules are created by those other Amazon Web Services services to support functionality in those services. You
5148
* can delete these rules using the <code>Force</code> option, but you should do so only if you

‎clients/client-cloudwatch-events/src/commands/DescribeApiDestinationCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat
5252
* // ApiDestinationArn: "STRING_VALUE",
5353
* // Name: "STRING_VALUE",
5454
* // Description: "STRING_VALUE",
55-
* // ApiDestinationState: "STRING_VALUE",
55+
* // ApiDestinationState: "ACTIVE" || "INACTIVE",
5656
* // ConnectionArn: "STRING_VALUE",
5757
* // InvocationEndpoint: "STRING_VALUE",
58-
* // HttpMethod: "STRING_VALUE",
58+
* // HttpMethod: "POST" || "GET" || "HEAD" || "OPTIONS" || "PUT" || "PATCH" || "DELETE",
5959
* // InvocationRateLimitPerSecond: Number("int"),
6060
* // CreationTime: new Date("TIMESTAMP"),
6161
* // LastModifiedTime: new Date("TIMESTAMP"),

‎clients/client-cloudwatch-events/src/commands/DescribeArchiveCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _
5454
* // EventSourceArn: "STRING_VALUE",
5555
* // Description: "STRING_VALUE",
5656
* // EventPattern: "STRING_VALUE",
57-
* // State: "STRING_VALUE",
57+
* // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
5858
* // StateReason: "STRING_VALUE",
5959
* // RetentionDays: Number("int"),
6060
* // SizeBytes: Number("long"),

‎clients/client-cloudwatch-events/src/commands/DescribeConnectionCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
5252
* // ConnectionArn: "STRING_VALUE",
5353
* // Name: "STRING_VALUE",
5454
* // Description: "STRING_VALUE",
55-
* // ConnectionState: "STRING_VALUE",
55+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
5656
* // StateReason: "STRING_VALUE",
57-
* // AuthorizationType: "STRING_VALUE",
57+
* // AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
5858
* // SecretArn: "STRING_VALUE",
5959
* // AuthParameters: { // ConnectionAuthResponseParameters
6060
* // BasicAuthParameters: { // ConnectionBasicAuthResponseParameters
@@ -65,7 +65,7 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
6565
* // ClientID: "STRING_VALUE",
6666
* // },
6767
* // AuthorizationEndpoint: "STRING_VALUE",
68-
* // HttpMethod: "STRING_VALUE",
68+
* // HttpMethod: "GET" || "POST" || "PUT",
6969
* // OAuthHttpParameters: { // ConnectionHttpParameters
7070
* // HeaderParameters: [ // ConnectionHeaderParametersList
7171
* // { // ConnectionHeaderParameter

‎clients/client-cloudwatch-events/src/commands/DescribeEventSourceCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes
5555
* // CreationTime: new Date("TIMESTAMP"),
5656
* // ExpirationTime: new Date("TIMESTAMP"),
5757
* // Name: "STRING_VALUE",
58-
* // State: "STRING_VALUE",
58+
* // State: "PENDING" || "ACTIVE" || "DELETED",
5959
* // };
6060
*
6161
* ```

‎clients/client-cloudwatch-events/src/commands/DescribeReplayCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export interface DescribeReplayCommandOutput extends DescribeReplayResponse, __M
6060
* // ReplayName: "STRING_VALUE",
6161
* // ReplayArn: "STRING_VALUE",
6262
* // Description: "STRING_VALUE",
63-
* // State: "STRING_VALUE",
63+
* // State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED",
6464
* // StateReason: "STRING_VALUE",
6565
* // EventSourceArn: "STRING_VALUE",
6666
* // Destination: { // ReplayDestination

‎clients/client-cloudwatch-events/src/commands/DescribeRuleCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __Metad
5656
* // Arn: "STRING_VALUE",
5757
* // EventPattern: "STRING_VALUE",
5858
* // ScheduleExpression: "STRING_VALUE",
59-
* // State: "STRING_VALUE",
59+
* // State: "ENABLED" || "DISABLED",
6060
* // Description: "STRING_VALUE",
6161
* // RoleArn: "STRING_VALUE",
6262
* // ManagedBy: "STRING_VALUE",

‎clients/client-cloudwatch-events/src/commands/DisableRuleCommand.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {}
3838
* @public
3939
* <p>Disables the specified rule. A disabled rule won't match any events, and won't
4040
* self-trigger if it has a schedule expression.</p>
41-
*
4241
* <p>When you disable a rule, incoming events might continue to match to the disabled rule.
4342
* Allow a short period of time for changes to take effect.</p>
4443
* @example

‎clients/client-cloudwatch-events/src/commands/EnableRuleCommand.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {}
3737
/**
3838
* @public
3939
* <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
40-
*
4140
* <p>When you enable a rule, incoming events might not immediately start matching to a newly
4241
* enabled rule. Allow a short period of time for changes to take effect.</p>
4342
* @example

‎clients/client-cloudwatch-events/src/commands/ListApiDestinationsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ export interface ListApiDestinationsCommandOutput extends ListApiDestinationsRes
5656
* // { // ApiDestination
5757
* // ApiDestinationArn: "STRING_VALUE",
5858
* // Name: "STRING_VALUE",
59-
* // ApiDestinationState: "STRING_VALUE",
59+
* // ApiDestinationState: "ACTIVE" || "INACTIVE",
6060
* // ConnectionArn: "STRING_VALUE",
6161
* // InvocationEndpoint: "STRING_VALUE",
62-
* // HttpMethod: "STRING_VALUE",
62+
* // HttpMethod: "POST" || "GET" || "HEAD" || "OPTIONS" || "PUT" || "PATCH" || "DELETE",
6363
* // InvocationRateLimitPerSecond: Number("int"),
6464
* // CreationTime: new Date("TIMESTAMP"),
6565
* // LastModifiedTime: new Date("TIMESTAMP"),

‎clients/client-cloudwatch-events/src/commands/ListArchivesCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface ListArchivesCommandOutput extends ListArchivesResponse, __Metad
4747
* const input = { // ListArchivesRequest
4848
* NamePrefix: "STRING_VALUE",
4949
* EventSourceArn: "STRING_VALUE",
50-
* State: "STRING_VALUE",
50+
* State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
5151
* NextToken: "STRING_VALUE",
5252
* Limit: Number("int"),
5353
* };
@@ -58,7 +58,7 @@ export interface ListArchivesCommandOutput extends ListArchivesResponse, __Metad
5858
* // { // Archive
5959
* // ArchiveName: "STRING_VALUE",
6060
* // EventSourceArn: "STRING_VALUE",
61-
* // State: "STRING_VALUE",
61+
* // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
6262
* // StateReason: "STRING_VALUE",
6363
* // RetentionDays: Number("int"),
6464
* // SizeBytes: Number("long"),

‎clients/client-cloudwatch-events/src/commands/ListConnectionsCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _
4545
* const client = new CloudWatchEventsClient(config);
4646
* const input = { // ListConnectionsRequest
4747
* NamePrefix: "STRING_VALUE",
48-
* ConnectionState: "STRING_VALUE",
48+
* ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
4949
* NextToken: "STRING_VALUE",
5050
* Limit: Number("int"),
5151
* };
@@ -56,9 +56,9 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _
5656
* // { // Connection
5757
* // ConnectionArn: "STRING_VALUE",
5858
* // Name: "STRING_VALUE",
59-
* // ConnectionState: "STRING_VALUE",
59+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
6060
* // StateReason: "STRING_VALUE",
61-
* // AuthorizationType: "STRING_VALUE",
61+
* // AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
6262
* // CreationTime: new Date("TIMESTAMP"),
6363
* // LastModifiedTime: new Date("TIMESTAMP"),
6464
* // LastAuthorizedTime: new Date("TIMESTAMP"),

‎clients/client-cloudwatch-events/src/commands/ListEventSourcesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export interface ListEventSourcesCommandOutput extends ListEventSourcesResponse,
5959
* // CreationTime: new Date("TIMESTAMP"),
6060
* // ExpirationTime: new Date("TIMESTAMP"),
6161
* // Name: "STRING_VALUE",
62-
* // State: "STRING_VALUE",
62+
* // State: "PENDING" || "ACTIVE" || "DELETED",
6363
* // },
6464
* // ],
6565
* // NextToken: "STRING_VALUE",

‎clients/client-cloudwatch-events/src/commands/ListPartnerEventSourceAccountsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export interface ListPartnerEventSourceAccountsCommandOutput
6363
* // Account: "STRING_VALUE",
6464
* // CreationTime: new Date("TIMESTAMP"),
6565
* // ExpirationTime: new Date("TIMESTAMP"),
66-
* // State: "STRING_VALUE",
66+
* // State: "PENDING" || "ACTIVE" || "DELETED",
6767
* // },
6868
* // ],
6969
* // NextToken: "STRING_VALUE",

‎clients/client-cloudwatch-events/src/commands/ListReplaysCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface ListReplaysCommandOutput extends ListReplaysResponse, __Metadat
4646
* const client = new CloudWatchEventsClient(config);
4747
* const input = { // ListReplaysRequest
4848
* NamePrefix: "STRING_VALUE",
49-
* State: "STRING_VALUE",
49+
* State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED",
5050
* EventSourceArn: "STRING_VALUE",
5151
* NextToken: "STRING_VALUE",
5252
* Limit: Number("int"),
@@ -58,7 +58,7 @@ export interface ListReplaysCommandOutput extends ListReplaysResponse, __Metadat
5858
* // { // Replay
5959
* // ReplayName: "STRING_VALUE",
6060
* // EventSourceArn: "STRING_VALUE",
61-
* // State: "STRING_VALUE",
61+
* // State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED",
6262
* // StateReason: "STRING_VALUE",
6363
* // EventStartTime: new Date("TIMESTAMP"),
6464
* // EventEndTime: new Date("TIMESTAMP"),

‎clients/client-cloudwatch-events/src/commands/ListRulesCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
3838
* @public
3939
* <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
4040
* a prefix to match to the rule names.</p>
41-
*
4241
* <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
4342
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
4443
* @example
@@ -61,7 +60,7 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
6160
* // Name: "STRING_VALUE",
6261
* // Arn: "STRING_VALUE",
6362
* // EventPattern: "STRING_VALUE",
64-
* // State: "STRING_VALUE",
63+
* // State: "ENABLED" || "DISABLED",
6564
* // Description: "STRING_VALUE",
6665
* // ScheduleExpression: "STRING_VALUE",
6766
* // RoleArn: "STRING_VALUE",

‎clients/client-cloudwatch-events/src/commands/ListTargetsByRuleCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons
8181
* // EcsParameters: { // EcsParameters
8282
* // TaskDefinitionArn: "STRING_VALUE", // required
8383
* // TaskCount: Number("int"),
84-
* // LaunchType: "STRING_VALUE",
84+
* // LaunchType: "EC2" || "FARGATE" || "EXTERNAL",
8585
* // NetworkConfiguration: { // NetworkConfiguration
8686
* // awsvpcConfiguration: { // AwsVpcConfiguration
8787
* // Subnets: [ // StringList // required
@@ -90,7 +90,7 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons
9090
* // SecurityGroups: [
9191
* // "STRING_VALUE",
9292
* // ],
93-
* // AssignPublicIp: "STRING_VALUE",
93+
* // AssignPublicIp: "ENABLED" || "DISABLED",
9494
* // },
9595
* // },
9696
* // PlatformVersion: "STRING_VALUE",
@@ -106,17 +106,17 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons
106106
* // EnableExecuteCommand: true || false,
107107
* // PlacementConstraints: [ // PlacementConstraints
108108
* // { // PlacementConstraint
109-
* // type: "STRING_VALUE",
109+
* // type: "distinctInstance" || "memberOf",
110110
* // expression: "STRING_VALUE",
111111
* // },
112112
* // ],
113113
* // PlacementStrategy: [ // PlacementStrategies
114114
* // { // PlacementStrategy
115-
* // type: "STRING_VALUE",
115+
* // type: "random" || "spread" || "binpack",
116116
* // field: "STRING_VALUE",
117117
* // },
118118
* // ],
119-
* // PropagateTags: "STRING_VALUE",
119+
* // PropagateTags: "TASK_DEFINITION",
120120
* // ReferenceId: "STRING_VALUE",
121121
* // Tags: [ // TagList
122122
* // { // Tag

‎clients/client-cloudwatch-events/src/commands/PutPermissionCommand.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,16 @@ export interface PutPermissionCommandOutput extends __MetadataBearer {}
4242
* account. </p>
4343
* <p>For another account to send events to your account, that external account must have an
4444
* EventBridge rule with your account's event bus as a target.</p>
45-
*
4645
* <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
4746
* <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
4847
* members of the same Amazon Web Services organization, you can run <code>PutPermission</code> once specifying
4948
* <code>Principal</code> as "*" and specifying the Amazon Web Services organization ID in
5049
* <code>Condition</code>, to grant permissions to all accounts in that organization.</p>
51-
*
5250
* <p>If you grant permissions using an organization, then accounts in that organization must
5351
* specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
5452
* add your account's event bus as a target. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
5553
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
5654
* Guide</i>.</p>
57-
*
5855
* <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
5956
* @example
6057
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)