Skip to content

Commit

Permalink
feat(client-cloudwatch-events): Documentation updates for CloudWatch …
Browse files Browse the repository at this point in the history
…Events.
  • Loading branch information
awstools committed Aug 31, 2023
1 parent 58d1b48 commit 6f8e057
Show file tree
Hide file tree
Showing 34 changed files with 1,104 additions and 1,909 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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",
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
* // };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
* // };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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"),
* // };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,11 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {}
* @public
* <p>Deletes the specified rule.</p>
* <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>
*
* <p>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.</p>
*
* <p>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, <code>ResourceNotFoundException</code> is
* returned.</p>
*
* <p>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 <code>Force</code> option, but you should do so only if you
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {}
* @public
* <p>Disables the specified rule. A disabled rule won't match any events, and won't
* self-trigger if it has a schedule expression.</p>
*
* <p>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.</p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {}
/**
* @public
* <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
*
* <p>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.</p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
* };
Expand All @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
* };
Expand All @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand All @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
* @public
* <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
* a prefix to match to the rule names.</p>
*
* <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
* @example
Expand All @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -90,7 +90,7 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons
* // SecurityGroups: [
* // "STRING_VALUE",
* // ],
* // AssignPublicIp: "STRING_VALUE",
* // AssignPublicIp: "ENABLED" || "DISABLED",
* // },
* // },
* // PlatformVersion: "STRING_VALUE",
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,16 @@ export interface PutPermissionCommandOutput extends __MetadataBearer {}
* account. </p>
* <p>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.</p>
*
* <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
* <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
* members of the same Amazon Web Services organization, you can run <code>PutPermission</code> once specifying
* <code>Principal</code> as "*" and specifying the Amazon Web Services organization ID in
* <code>Condition</code>, to grant permissions to all accounts in that organization.</p>
*
* <p>If you grant permissions using an organization, then accounts in that organization must
* specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
* 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
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
* Guide</i>.</p>
*
* <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Loading

0 comments on commit 6f8e057

Please sign in to comment.