@aws-sdk/client-eventbridge 3.321.1 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/dist-types/commands/ActivateEventSourceCommand.d.ts +4 -0
  2. package/dist-types/commands/CancelReplayCommand.d.ts +8 -0
  3. package/dist-types/commands/CreateApiDestinationCommand.d.ts +9 -0
  4. package/dist-types/commands/CreateArchiveCommand.d.ts +9 -0
  5. package/dist-types/commands/CreateConnectionCommand.d.ts +9 -0
  6. package/dist-types/commands/CreateEndpointCommand.d.ts +27 -0
  7. package/dist-types/commands/CreateEventBusCommand.d.ts +6 -0
  8. package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +6 -0
  9. package/dist-types/commands/DeactivateEventSourceCommand.d.ts +4 -0
  10. package/dist-types/commands/DeauthorizeConnectionCommand.d.ts +10 -0
  11. package/dist-types/commands/DeleteApiDestinationCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteArchiveCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteConnectionCommand.d.ts +10 -0
  14. package/dist-types/commands/DeleteEndpointCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteEventBusCommand.d.ts +4 -0
  16. package/dist-types/commands/DeletePartnerEventSourceCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteRuleCommand.d.ts +4 -0
  18. package/dist-types/commands/DescribeApiDestinationCommand.d.ts +15 -0
  19. package/dist-types/commands/DescribeArchiveCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeConnectionCommand.d.ts +76 -0
  21. package/dist-types/commands/DescribeEndpointCommand.d.ts +33 -0
  22. package/dist-types/commands/DescribeEventBusCommand.d.ts +8 -0
  23. package/dist-types/commands/DescribeEventSourceCommand.d.ts +11 -0
  24. package/dist-types/commands/DescribePartnerEventSourceCommand.d.ts +7 -0
  25. package/dist-types/commands/DescribeReplayCommand.d.ts +22 -0
  26. package/dist-types/commands/DescribeRuleCommand.d.ts +15 -0
  27. package/dist-types/commands/DisableRuleCommand.d.ts +4 -0
  28. package/dist-types/commands/EnableRuleCommand.d.ts +4 -0
  29. package/dist-types/commands/ListApiDestinationsCommand.d.ts +19 -0
  30. package/dist-types/commands/ListArchivesCommand.d.ts +18 -0
  31. package/dist-types/commands/ListConnectionsCommand.d.ts +18 -0
  32. package/dist-types/commands/ListEndpointsCommand.d.ts +38 -0
  33. package/dist-types/commands/ListEventBusesCommand.d.ts +13 -0
  34. package/dist-types/commands/ListEventSourcesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListPartnerEventSourceAccountsCommand.d.ts +14 -0
  36. package/dist-types/commands/ListPartnerEventSourcesCommand.d.ts +12 -0
  37. package/dist-types/commands/ListReplaysCommand.d.ts +19 -0
  38. package/dist-types/commands/ListRuleNamesByTargetCommand.d.ts +9 -0
  39. package/dist-types/commands/ListRulesCommand.d.ts +19 -0
  40. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  41. package/dist-types/commands/ListTargetsByRuleCommand.d.ts +131 -0
  42. package/dist-types/commands/PutEventsCommand.d.ts +13 -0
  43. package/dist-types/commands/PutPartnerEventsCommand.d.ts +13 -0
  44. package/dist-types/commands/PutPermissionCommand.d.ts +4 -0
  45. package/dist-types/commands/PutRuleCommand.d.ts +6 -0
  46. package/dist-types/commands/PutTargetsCommand.d.ts +13 -0
  47. package/dist-types/commands/RemovePermissionCommand.d.ts +4 -0
  48. package/dist-types/commands/RemoveTargetsCommand.d.ts +13 -0
  49. package/dist-types/commands/StartReplayCommand.d.ts +9 -0
  50. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  51. package/dist-types/commands/TestEventPatternCommand.d.ts +6 -0
  52. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  53. package/dist-types/commands/UpdateApiDestinationCommand.d.ts +9 -0
  54. package/dist-types/commands/UpdateArchiveCommand.d.ts +9 -0
  55. package/dist-types/commands/UpdateConnectionCommand.d.ts +10 -0
  56. package/dist-types/commands/UpdateEndpointCommand.d.ts +29 -0
  57. package/package.json +16 -16
@@ -32,6 +32,8 @@ export interface ActivateEventSourceCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new ActivateEventSourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param ActivateEventSourceCommandInput - {@link ActivateEventSourceCommandInput}
@@ -55,6 +57,8 @@ export interface ActivateEventSourceCommandOutput extends __MetadataBearer {
55
57
  * @throws {@link ResourceNotFoundException} (client fault)
56
58
  * <p>An entity that you specified does not exist.</p>
57
59
  *
60
+ * @throws {@link EventBridgeServiceException}
61
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
58
62
  *
59
63
  */
60
64
  export declare class ActivateEventSourceCommand extends $Command<ActivateEventSourceCommandInput, ActivateEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad
31
31
  * };
32
32
  * const command = new CancelReplayCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // CancelReplayResponse
35
+ * // ReplayArn: "STRING_VALUE",
36
+ * // State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED",
37
+ * // StateReason: "STRING_VALUE",
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param CancelReplayCommandInput - {@link CancelReplayCommandInput}
@@ -52,6 +58,8 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad
52
58
  * @throws {@link ResourceNotFoundException} (client fault)
53
59
  * <p>An entity that you specified does not exist.</p>
54
60
  *
61
+ * @throws {@link EventBridgeServiceException}
62
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
55
63
  *
56
64
  */
57
65
  export declare class CancelReplayCommand extends $Command<CancelReplayCommandInput, CancelReplayCommandOutput, EventBridgeClientResolvedConfig> {
@@ -37,6 +37,13 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR
37
37
  * };
38
38
  * const command = new CreateApiDestinationCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // CreateApiDestinationResponse
41
+ * // ApiDestinationArn: "STRING_VALUE",
42
+ * // ApiDestinationState: "ACTIVE" || "INACTIVE",
43
+ * // CreationTime: new Date("TIMESTAMP"),
44
+ * // LastModifiedTime: new Date("TIMESTAMP"),
45
+ * // };
46
+ *
40
47
  * ```
41
48
  *
42
49
  * @param CreateApiDestinationCommandInput - {@link CreateApiDestinationCommandInput}
@@ -58,6 +65,8 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR
58
65
  * @throws {@link ResourceNotFoundException} (client fault)
59
66
  * <p>An entity that you specified does not exist.</p>
60
67
  *
68
+ * @throws {@link EventBridgeServiceException}
69
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
61
70
  *
62
71
  */
63
72
  export declare class CreateApiDestinationCommand extends $Command<CreateApiDestinationCommandInput, CreateApiDestinationCommandOutput, EventBridgeClientResolvedConfig> {
@@ -39,6 +39,13 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met
39
39
  * };
40
40
  * const command = new CreateArchiveCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CreateArchiveResponse
43
+ * // ArchiveArn: "STRING_VALUE",
44
+ * // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
45
+ * // StateReason: "STRING_VALUE",
46
+ * // CreationTime: new Date("TIMESTAMP"),
47
+ * // };
48
+ *
42
49
  * ```
43
50
  *
44
51
  * @param CreateArchiveCommandInput - {@link CreateArchiveCommandInput}
@@ -66,6 +73,8 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met
66
73
  * @throws {@link ResourceNotFoundException} (client fault)
67
74
  * <p>An entity that you specified does not exist.</p>
68
75
  *
76
+ * @throws {@link EventBridgeServiceException}
77
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
69
78
  *
70
79
  */
71
80
  export declare class CreateArchiveCommand extends $Command<CreateArchiveCommandInput, CreateArchiveCommandOutput, EventBridgeClientResolvedConfig> {
@@ -98,6 +98,13 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
98
98
  * };
99
99
  * const command = new CreateConnectionCommand(input);
100
100
  * const response = await client.send(command);
101
+ * // { // CreateConnectionResponse
102
+ * // ConnectionArn: "STRING_VALUE",
103
+ * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
104
+ * // CreationTime: new Date("TIMESTAMP"),
105
+ * // LastModifiedTime: new Date("TIMESTAMP"),
106
+ * // };
107
+ *
101
108
  * ```
102
109
  *
103
110
  * @param CreateConnectionCommandInput - {@link CreateConnectionCommandInput}
@@ -116,6 +123,8 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
116
123
  * @throws {@link ResourceAlreadyExistsException} (client fault)
117
124
  * <p>The resource you are trying to create already exists.</p>
118
125
  *
126
+ * @throws {@link EventBridgeServiceException}
127
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
119
128
  *
120
129
  */
121
130
  export declare class CreateConnectionCommand extends $Command<CreateConnectionCommandInput, CreateConnectionCommandOutput, EventBridgeClientResolvedConfig> {
@@ -53,6 +53,31 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
53
53
  * };
54
54
  * const command = new CreateEndpointCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // CreateEndpointResponse
57
+ * // Name: "STRING_VALUE",
58
+ * // Arn: "STRING_VALUE",
59
+ * // RoutingConfig: { // RoutingConfig
60
+ * // FailoverConfig: { // FailoverConfig
61
+ * // Primary: { // Primary
62
+ * // HealthCheck: "STRING_VALUE", // required
63
+ * // },
64
+ * // Secondary: { // Secondary
65
+ * // Route: "STRING_VALUE", // required
66
+ * // },
67
+ * // },
68
+ * // },
69
+ * // ReplicationConfig: { // ReplicationConfig
70
+ * // State: "ENABLED" || "DISABLED",
71
+ * // },
72
+ * // EventBuses: [ // EndpointEventBusList
73
+ * // { // EndpointEventBus
74
+ * // EventBusArn: "STRING_VALUE", // required
75
+ * // },
76
+ * // ],
77
+ * // RoleArn: "STRING_VALUE",
78
+ * // State: "ACTIVE" || "CREATING" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
79
+ * // };
80
+ *
56
81
  * ```
57
82
  *
58
83
  * @param CreateEndpointCommandInput - {@link CreateEndpointCommandInput}
@@ -71,6 +96,8 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
71
96
  * @throws {@link ResourceAlreadyExistsException} (client fault)
72
97
  * <p>The resource you are trying to create already exists.</p>
73
98
  *
99
+ * @throws {@link EventBridgeServiceException}
100
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
74
101
  *
75
102
  */
76
103
  export declare class CreateEndpointCommand extends $Command<CreateEndpointCommandInput, CreateEndpointCommandOutput, EventBridgeClientResolvedConfig> {
@@ -40,6 +40,10 @@ export interface CreateEventBusCommandOutput extends CreateEventBusResponse, __M
40
40
  * };
41
41
  * const command = new CreateEventBusCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // CreateEventBusResponse
44
+ * // EventBusArn: "STRING_VALUE",
45
+ * // };
46
+ *
43
47
  * ```
44
48
  *
45
49
  * @param CreateEventBusCommandInput - {@link CreateEventBusCommandInput}
@@ -70,6 +74,8 @@ export interface CreateEventBusCommandOutput extends CreateEventBusResponse, __M
70
74
  * @throws {@link ResourceNotFoundException} (client fault)
71
75
  * <p>An entity that you specified does not exist.</p>
72
76
  *
77
+ * @throws {@link EventBridgeServiceException}
78
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
73
79
  *
74
80
  */
75
81
  export declare class CreateEventBusCommand extends $Command<CreateEventBusCommandInput, CreateEventBusCommandOutput, EventBridgeClientResolvedConfig> {
@@ -55,6 +55,10 @@ export interface CreatePartnerEventSourceCommandOutput extends CreatePartnerEven
55
55
  * };
56
56
  * const command = new CreatePartnerEventSourceCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // CreatePartnerEventSourceResponse
59
+ * // EventSourceArn: "STRING_VALUE",
60
+ * // };
61
+ *
58
62
  * ```
59
63
  *
60
64
  * @param CreatePartnerEventSourceCommandInput - {@link CreatePartnerEventSourceCommandInput}
@@ -79,6 +83,8 @@ export interface CreatePartnerEventSourceCommandOutput extends CreatePartnerEven
79
83
  * @throws {@link ResourceAlreadyExistsException} (client fault)
80
84
  * <p>The resource you are trying to create already exists.</p>
81
85
  *
86
+ * @throws {@link EventBridgeServiceException}
87
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
82
88
  *
83
89
  */
84
90
  export declare class CreatePartnerEventSourceCommand extends $Command<CreatePartnerEventSourceCommandInput, CreatePartnerEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeactivateEventSourceCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new DeactivateEventSourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeactivateEventSourceCommandInput - {@link DeactivateEventSourceCommandInput}
@@ -58,6 +60,8 @@ export interface DeactivateEventSourceCommandOutput extends __MetadataBearer {
58
60
  * @throws {@link ResourceNotFoundException} (client fault)
59
61
  * <p>An entity that you specified does not exist.</p>
60
62
  *
63
+ * @throws {@link EventBridgeServiceException}
64
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeactivateEventSourceCommand extends $Command<DeactivateEventSourceCommandInput, DeactivateEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
@@ -32,6 +32,14 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio
32
32
  * };
33
33
  * const command = new DeauthorizeConnectionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeauthorizeConnectionResponse
36
+ * // ConnectionArn: "STRING_VALUE",
37
+ * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
38
+ * // CreationTime: new Date("TIMESTAMP"),
39
+ * // LastModifiedTime: new Date("TIMESTAMP"),
40
+ * // LastAuthorizedTime: new Date("TIMESTAMP"),
41
+ * // };
42
+ *
35
43
  * ```
36
44
  *
37
45
  * @param DeauthorizeConnectionCommandInput - {@link DeauthorizeConnectionCommandInput}
@@ -49,6 +57,8 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio
49
57
  * @throws {@link ResourceNotFoundException} (client fault)
50
58
  * <p>An entity that you specified does not exist.</p>
51
59
  *
60
+ * @throws {@link EventBridgeServiceException}
61
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
52
62
  *
53
63
  */
54
64
  export declare class DeauthorizeConnectionCommand extends $Command<DeauthorizeConnectionCommandInput, DeauthorizeConnectionCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteApiDestinationCommandOutput extends DeleteApiDestinationR
31
31
  * };
32
32
  * const command = new DeleteApiDestinationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteApiDestinationCommandInput - {@link DeleteApiDestinationCommandInput}
@@ -48,6 +50,8 @@ export interface DeleteApiDestinationCommandOutput extends DeleteApiDestinationR
48
50
  * @throws {@link ResourceNotFoundException} (client fault)
49
51
  * <p>An entity that you specified does not exist.</p>
50
52
  *
53
+ * @throws {@link EventBridgeServiceException}
54
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
51
55
  *
52
56
  */
53
57
  export declare class DeleteApiDestinationCommand extends $Command<DeleteApiDestinationCommandInput, DeleteApiDestinationCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteArchiveCommandOutput extends DeleteArchiveResponse, __Met
31
31
  * };
32
32
  * const command = new DeleteArchiveCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteArchiveCommandInput - {@link DeleteArchiveCommandInput}
@@ -48,6 +50,8 @@ export interface DeleteArchiveCommandOutput extends DeleteArchiveResponse, __Met
48
50
  * @throws {@link ResourceNotFoundException} (client fault)
49
51
  * <p>An entity that you specified does not exist.</p>
50
52
  *
53
+ * @throws {@link EventBridgeServiceException}
54
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
51
55
  *
52
56
  */
53
57
  export declare class DeleteArchiveCommand extends $Command<DeleteArchiveCommandInput, DeleteArchiveCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,14 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse,
31
31
  * };
32
32
  * const command = new DeleteConnectionCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteConnectionResponse
35
+ * // ConnectionArn: "STRING_VALUE",
36
+ * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
37
+ * // CreationTime: new Date("TIMESTAMP"),
38
+ * // LastModifiedTime: new Date("TIMESTAMP"),
39
+ * // LastAuthorizedTime: new Date("TIMESTAMP"),
40
+ * // };
41
+ *
34
42
  * ```
35
43
  *
36
44
  * @param DeleteConnectionCommandInput - {@link DeleteConnectionCommandInput}
@@ -48,6 +56,8 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse,
48
56
  * @throws {@link ResourceNotFoundException} (client fault)
49
57
  * <p>An entity that you specified does not exist.</p>
50
58
  *
59
+ * @throws {@link EventBridgeServiceException}
60
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
51
61
  *
52
62
  */
53
63
  export declare class DeleteConnectionCommand extends $Command<DeleteConnectionCommandInput, DeleteConnectionCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M
31
31
  * };
32
32
  * const command = new DeleteEndpointCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteEndpointCommandInput - {@link DeleteEndpointCommandInput}
@@ -48,6 +50,8 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M
48
50
  * @throws {@link ResourceNotFoundException} (client fault)
49
51
  * <p>An entity that you specified does not exist.</p>
50
52
  *
53
+ * @throws {@link EventBridgeServiceException}
54
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
51
55
  *
52
56
  */
53
57
  export declare class DeleteEndpointCommand extends $Command<DeleteEndpointCommandInput, DeleteEndpointCommandOutput, EventBridgeClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteEventBusCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteEventBusCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteEventBusCommandInput - {@link DeleteEventBusCommandInput}
@@ -46,6 +48,8 @@ export interface DeleteEventBusCommandOutput extends __MetadataBearer {
46
48
  * @throws {@link InternalException} (server fault)
47
49
  * <p>This exception occurs due to unexpected causes.</p>
48
50
  *
51
+ * @throws {@link EventBridgeServiceException}
52
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
49
53
  *
50
54
  */
51
55
  export declare class DeleteEventBusCommand extends $Command<DeleteEventBusCommandInput, DeleteEventBusCommandOutput, EventBridgeClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer
36
36
  * };
37
37
  * const command = new DeletePartnerEventSourceCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param DeletePartnerEventSourceCommandInput - {@link DeletePartnerEventSourceCommandInput}
@@ -53,6 +55,8 @@ export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer
53
55
  * @throws {@link OperationDisabledException} (client fault)
54
56
  * <p>The operation you are attempting is not available in this region.</p>
55
57
  *
58
+ * @throws {@link EventBridgeServiceException}
59
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeletePartnerEventSourceCommand extends $Command<DeletePartnerEventSourceCommandInput, DeletePartnerEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
@@ -43,6 +43,8 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {
43
43
  * };
44
44
  * const command = new DeleteRuleCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // {};
47
+ *
46
48
  * ```
47
49
  *
48
50
  * @param DeleteRuleCommandInput - {@link DeleteRuleCommandInput}
@@ -68,6 +70,8 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {
68
70
  * @throws {@link ResourceNotFoundException} (client fault)
69
71
  * <p>An entity that you specified does not exist.</p>
70
72
  *
73
+ * @throws {@link EventBridgeServiceException}
74
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
71
75
  *
72
76
  */
73
77
  export declare class DeleteRuleCommand extends $Command<DeleteRuleCommandInput, DeleteRuleCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,19 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat
31
31
  * };
32
32
  * const command = new DescribeApiDestinationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeApiDestinationResponse
35
+ * // ApiDestinationArn: "STRING_VALUE",
36
+ * // Name: "STRING_VALUE",
37
+ * // Description: "STRING_VALUE",
38
+ * // ApiDestinationState: "ACTIVE" || "INACTIVE",
39
+ * // ConnectionArn: "STRING_VALUE",
40
+ * // InvocationEndpoint: "STRING_VALUE",
41
+ * // HttpMethod: "POST" || "GET" || "HEAD" || "OPTIONS" || "PUT" || "PATCH" || "DELETE",
42
+ * // InvocationRateLimitPerSecond: Number("int"),
43
+ * // CreationTime: new Date("TIMESTAMP"),
44
+ * // LastModifiedTime: new Date("TIMESTAMP"),
45
+ * // };
46
+ *
34
47
  * ```
35
48
  *
36
49
  * @param DescribeApiDestinationCommandInput - {@link DescribeApiDestinationCommandInput}
@@ -45,6 +58,8 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat
45
58
  * @throws {@link ResourceNotFoundException} (client fault)
46
59
  * <p>An entity that you specified does not exist.</p>
47
60
  *
61
+ * @throws {@link EventBridgeServiceException}
62
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
48
63
  *
49
64
  */
50
65
  export declare class DescribeApiDestinationCommand extends $Command<DescribeApiDestinationCommandInput, DescribeApiDestinationCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,20 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _
31
31
  * };
32
32
  * const command = new DescribeArchiveCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeArchiveResponse
35
+ * // ArchiveArn: "STRING_VALUE",
36
+ * // ArchiveName: "STRING_VALUE",
37
+ * // EventSourceArn: "STRING_VALUE",
38
+ * // Description: "STRING_VALUE",
39
+ * // EventPattern: "STRING_VALUE",
40
+ * // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
41
+ * // StateReason: "STRING_VALUE",
42
+ * // RetentionDays: Number("int"),
43
+ * // SizeBytes: Number("long"),
44
+ * // EventCount: Number("long"),
45
+ * // CreationTime: new Date("TIMESTAMP"),
46
+ * // };
47
+ *
34
48
  * ```
35
49
  *
36
50
  * @param DescribeArchiveCommandInput - {@link DescribeArchiveCommandInput}
@@ -48,6 +62,8 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _
48
62
  * @throws {@link ResourceNotFoundException} (client fault)
49
63
  * <p>An entity that you specified does not exist.</p>
50
64
  *
65
+ * @throws {@link EventBridgeServiceException}
66
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
51
67
  *
52
68
  */
53
69
  export declare class DescribeArchiveCommand extends $Command<DescribeArchiveCommandInput, DescribeArchiveCommandOutput, EventBridgeClientResolvedConfig> {
@@ -31,6 +31,80 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
31
31
  * };
32
32
  * const command = new DescribeConnectionCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeConnectionResponse
35
+ * // ConnectionArn: "STRING_VALUE",
36
+ * // Name: "STRING_VALUE",
37
+ * // Description: "STRING_VALUE",
38
+ * // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
39
+ * // StateReason: "STRING_VALUE",
40
+ * // AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
41
+ * // SecretArn: "STRING_VALUE",
42
+ * // AuthParameters: { // ConnectionAuthResponseParameters
43
+ * // BasicAuthParameters: { // ConnectionBasicAuthResponseParameters
44
+ * // Username: "STRING_VALUE",
45
+ * // },
46
+ * // OAuthParameters: { // ConnectionOAuthResponseParameters
47
+ * // ClientParameters: { // ConnectionOAuthClientResponseParameters
48
+ * // ClientID: "STRING_VALUE",
49
+ * // },
50
+ * // AuthorizationEndpoint: "STRING_VALUE",
51
+ * // HttpMethod: "GET" || "POST" || "PUT",
52
+ * // OAuthHttpParameters: { // ConnectionHttpParameters
53
+ * // HeaderParameters: [ // ConnectionHeaderParametersList
54
+ * // { // ConnectionHeaderParameter
55
+ * // Key: "STRING_VALUE",
56
+ * // Value: "STRING_VALUE",
57
+ * // IsValueSecret: true || false,
58
+ * // },
59
+ * // ],
60
+ * // QueryStringParameters: [ // ConnectionQueryStringParametersList
61
+ * // { // ConnectionQueryStringParameter
62
+ * // Key: "STRING_VALUE",
63
+ * // Value: "STRING_VALUE",
64
+ * // IsValueSecret: true || false,
65
+ * // },
66
+ * // ],
67
+ * // BodyParameters: [ // ConnectionBodyParametersList
68
+ * // { // ConnectionBodyParameter
69
+ * // Key: "STRING_VALUE",
70
+ * // Value: "STRING_VALUE",
71
+ * // IsValueSecret: true || false,
72
+ * // },
73
+ * // ],
74
+ * // },
75
+ * // },
76
+ * // ApiKeyAuthParameters: { // ConnectionApiKeyAuthResponseParameters
77
+ * // ApiKeyName: "STRING_VALUE",
78
+ * // },
79
+ * // InvocationHttpParameters: {
80
+ * // HeaderParameters: [
81
+ * // {
82
+ * // Key: "STRING_VALUE",
83
+ * // Value: "STRING_VALUE",
84
+ * // IsValueSecret: true || false,
85
+ * // },
86
+ * // ],
87
+ * // QueryStringParameters: [
88
+ * // {
89
+ * // Key: "STRING_VALUE",
90
+ * // Value: "STRING_VALUE",
91
+ * // IsValueSecret: true || false,
92
+ * // },
93
+ * // ],
94
+ * // BodyParameters: [
95
+ * // {
96
+ * // Key: "STRING_VALUE",
97
+ * // Value: "STRING_VALUE",
98
+ * // IsValueSecret: true || false,
99
+ * // },
100
+ * // ],
101
+ * // },
102
+ * // },
103
+ * // CreationTime: new Date("TIMESTAMP"),
104
+ * // LastModifiedTime: new Date("TIMESTAMP"),
105
+ * // LastAuthorizedTime: new Date("TIMESTAMP"),
106
+ * // };
107
+ *
34
108
  * ```
35
109
  *
36
110
  * @param DescribeConnectionCommandInput - {@link DescribeConnectionCommandInput}
@@ -45,6 +119,8 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
45
119
  * @throws {@link ResourceNotFoundException} (client fault)
46
120
  * <p>An entity that you specified does not exist.</p>
47
121
  *
122
+ * @throws {@link EventBridgeServiceException}
123
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
48
124
  *
49
125
  */
50
126
  export declare class DescribeConnectionCommand extends $Command<DescribeConnectionCommandInput, DescribeConnectionCommandOutput, EventBridgeClientResolvedConfig> {
@@ -32,6 +32,37 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
32
32
  * };
33
33
  * const command = new DescribeEndpointCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeEndpointResponse
36
+ * // Name: "STRING_VALUE",
37
+ * // Description: "STRING_VALUE",
38
+ * // Arn: "STRING_VALUE",
39
+ * // RoutingConfig: { // RoutingConfig
40
+ * // FailoverConfig: { // FailoverConfig
41
+ * // Primary: { // Primary
42
+ * // HealthCheck: "STRING_VALUE", // required
43
+ * // },
44
+ * // Secondary: { // Secondary
45
+ * // Route: "STRING_VALUE", // required
46
+ * // },
47
+ * // },
48
+ * // },
49
+ * // ReplicationConfig: { // ReplicationConfig
50
+ * // State: "ENABLED" || "DISABLED",
51
+ * // },
52
+ * // EventBuses: [ // EndpointEventBusList
53
+ * // { // EndpointEventBus
54
+ * // EventBusArn: "STRING_VALUE", // required
55
+ * // },
56
+ * // ],
57
+ * // RoleArn: "STRING_VALUE",
58
+ * // EndpointId: "STRING_VALUE",
59
+ * // EndpointUrl: "STRING_VALUE",
60
+ * // State: "ACTIVE" || "CREATING" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
61
+ * // StateReason: "STRING_VALUE",
62
+ * // CreationTime: new Date("TIMESTAMP"),
63
+ * // LastModifiedTime: new Date("TIMESTAMP"),
64
+ * // };
65
+ *
35
66
  * ```
36
67
  *
37
68
  * @param DescribeEndpointCommandInput - {@link DescribeEndpointCommandInput}
@@ -46,6 +77,8 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
46
77
  * @throws {@link ResourceNotFoundException} (client fault)
47
78
  * <p>An entity that you specified does not exist.</p>
48
79
  *
80
+ * @throws {@link EventBridgeServiceException}
81
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
49
82
  *
50
83
  */
51
84
  export declare class DescribeEndpointCommand extends $Command<DescribeEndpointCommandInput, DescribeEndpointCommandOutput, EventBridgeClientResolvedConfig> {
@@ -37,6 +37,12 @@ export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse,
37
37
  * };
38
38
  * const command = new DescribeEventBusCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DescribeEventBusResponse
41
+ * // Name: "STRING_VALUE",
42
+ * // Arn: "STRING_VALUE",
43
+ * // Policy: "STRING_VALUE",
44
+ * // };
45
+ *
40
46
  * ```
41
47
  *
42
48
  * @param DescribeEventBusCommandInput - {@link DescribeEventBusCommandInput}
@@ -51,6 +57,8 @@ export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse,
51
57
  * @throws {@link ResourceNotFoundException} (client fault)
52
58
  * <p>An entity that you specified does not exist.</p>
53
59
  *
60
+ * @throws {@link EventBridgeServiceException}
61
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
54
62
  *
55
63
  */
56
64
  export declare class DescribeEventBusCommand extends $Command<DescribeEventBusCommandInput, DescribeEventBusCommandOutput, EventBridgeClientResolvedConfig> {
@@ -32,6 +32,15 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes
32
32
  * };
33
33
  * const command = new DescribeEventSourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeEventSourceResponse
36
+ * // Arn: "STRING_VALUE",
37
+ * // CreatedBy: "STRING_VALUE",
38
+ * // CreationTime: new Date("TIMESTAMP"),
39
+ * // ExpirationTime: new Date("TIMESTAMP"),
40
+ * // Name: "STRING_VALUE",
41
+ * // State: "PENDING" || "ACTIVE" || "DELETED",
42
+ * // };
43
+ *
35
44
  * ```
36
45
  *
37
46
  * @param DescribeEventSourceCommandInput - {@link DescribeEventSourceCommandInput}
@@ -49,6 +58,8 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes
49
58
  * @throws {@link ResourceNotFoundException} (client fault)
50
59
  * <p>An entity that you specified does not exist.</p>
51
60
  *
61
+ * @throws {@link EventBridgeServiceException}
62
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
52
63
  *
53
64
  */
54
65
  export declare class DescribeEventSourceCommand extends $Command<DescribeEventSourceCommandInput, DescribeEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
@@ -34,6 +34,11 @@ export interface DescribePartnerEventSourceCommandOutput extends DescribePartner
34
34
  * };
35
35
  * const command = new DescribePartnerEventSourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribePartnerEventSourceResponse
38
+ * // Arn: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // };
41
+ *
37
42
  * ```
38
43
  *
39
44
  * @param DescribePartnerEventSourceCommandInput - {@link DescribePartnerEventSourceCommandInput}
@@ -51,6 +56,8 @@ export interface DescribePartnerEventSourceCommandOutput extends DescribePartner
51
56
  * @throws {@link ResourceNotFoundException} (client fault)
52
57
  * <p>An entity that you specified does not exist.</p>
53
58
  *
59
+ * @throws {@link EventBridgeServiceException}
60
+ * <p>Base exception class for all service exceptions from EventBridge service.</p>
54
61
  *
55
62
  */
56
63
  export declare class DescribePartnerEventSourceCommand extends $Command<DescribePartnerEventSourceCommandInput, DescribePartnerEventSourceCommandOutput, EventBridgeClientResolvedConfig> {