@aws-sdk/client-eventbridge 3.295.0 → 3.297.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 (61) hide show
  1. package/dist-types/EventBridge.d.ts +57 -0
  2. package/dist-types/EventBridgeClient.d.ts +24 -4
  3. package/dist-types/commands/ActivateEventSourceCommand.d.ts +16 -0
  4. package/dist-types/commands/CancelReplayCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateApiDestinationCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateArchiveCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateConnectionCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateEndpointCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateEventBusCommand.d.ts +16 -0
  10. package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +16 -0
  11. package/dist-types/commands/DeactivateEventSourceCommand.d.ts +16 -0
  12. package/dist-types/commands/DeauthorizeConnectionCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteApiDestinationCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteArchiveCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteConnectionCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteEndpointCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteEventBusCommand.d.ts +16 -0
  18. package/dist-types/commands/DeletePartnerEventSourceCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteRuleCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeApiDestinationCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeArchiveCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeConnectionCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeEndpointCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeEventBusCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeEventSourceCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribePartnerEventSourceCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeReplayCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeRuleCommand.d.ts +16 -0
  29. package/dist-types/commands/DisableRuleCommand.d.ts +16 -0
  30. package/dist-types/commands/EnableRuleCommand.d.ts +16 -0
  31. package/dist-types/commands/ListApiDestinationsCommand.d.ts +16 -0
  32. package/dist-types/commands/ListArchivesCommand.d.ts +16 -0
  33. package/dist-types/commands/ListConnectionsCommand.d.ts +16 -0
  34. package/dist-types/commands/ListEndpointsCommand.d.ts +16 -0
  35. package/dist-types/commands/ListEventBusesCommand.d.ts +16 -0
  36. package/dist-types/commands/ListEventSourcesCommand.d.ts +16 -0
  37. package/dist-types/commands/ListPartnerEventSourceAccountsCommand.d.ts +16 -0
  38. package/dist-types/commands/ListPartnerEventSourcesCommand.d.ts +16 -0
  39. package/dist-types/commands/ListReplaysCommand.d.ts +16 -0
  40. package/dist-types/commands/ListRuleNamesByTargetCommand.d.ts +16 -0
  41. package/dist-types/commands/ListRulesCommand.d.ts +16 -0
  42. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  43. package/dist-types/commands/ListTargetsByRuleCommand.d.ts +16 -0
  44. package/dist-types/commands/PutEventsCommand.d.ts +16 -0
  45. package/dist-types/commands/PutPartnerEventsCommand.d.ts +16 -0
  46. package/dist-types/commands/PutPermissionCommand.d.ts +16 -0
  47. package/dist-types/commands/PutRuleCommand.d.ts +16 -0
  48. package/dist-types/commands/PutTargetsCommand.d.ts +16 -0
  49. package/dist-types/commands/RemovePermissionCommand.d.ts +16 -0
  50. package/dist-types/commands/RemoveTargetsCommand.d.ts +16 -0
  51. package/dist-types/commands/StartReplayCommand.d.ts +16 -0
  52. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  53. package/dist-types/commands/TestEventPatternCommand.d.ts +16 -0
  54. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  55. package/dist-types/commands/UpdateApiDestinationCommand.d.ts +16 -0
  56. package/dist-types/commands/UpdateArchiveCommand.d.ts +16 -0
  57. package/dist-types/commands/UpdateConnectionCommand.d.ts +16 -0
  58. package/dist-types/commands/UpdateEndpointCommand.d.ts +16 -0
  59. package/dist-types/models/EventBridgeServiceException.d.ts +2 -0
  60. package/dist-types/models/models_0.d.ts +449 -16
  61. package/package.json +30 -30
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DeletePartnerEventSourceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeletePartnerEventSourceCommand}.
8
10
  */
9
11
  export interface DeletePartnerEventSourceCommandInput extends DeletePartnerEventSourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeletePartnerEventSourceCommand}.
13
17
  */
14
18
  export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation is used by SaaS partners to delete a partner event source. This operation
18
23
  * is not used by Amazon Web Services customers.</p>
19
24
  * <p>When you delete an event source, the status of the corresponding partner event bus in the
@@ -29,6 +34,8 @@ export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeletePartnerEventSourceCommandInput - {@link DeletePartnerEventSourceCommandInput}
38
+ * @returns {@link DeletePartnerEventSourceCommandOutput}
32
39
  * @see {@link DeletePartnerEventSourceCommandInput} for command's `input` shape.
33
40
  * @see {@link DeletePartnerEventSourceCommandOutput} for command's `response` shape.
34
41
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer
47
54
  export declare class DeletePartnerEventSourceCommand extends $Command<DeletePartnerEventSourceCommandInput, DeletePartnerEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
48
55
  readonly input: DeletePartnerEventSourceCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeletePartnerEventSourceCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePartnerEventSourceCommandInput, DeletePartnerEventSourceCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DeleteRuleRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRuleCommand}.
8
10
  */
9
11
  export interface DeleteRuleCommandInput extends DeleteRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRuleCommand}.
13
17
  */
14
18
  export interface DeleteRuleCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified rule.</p>
18
23
  * <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>
19
24
  * <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
@@ -35,6 +40,8 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param DeleteRuleCommandInput - {@link DeleteRuleCommandInput}
44
+ * @returns {@link DeleteRuleCommandOutput}
38
45
  * @see {@link DeleteRuleCommandInput} for command's `input` shape.
39
46
  * @see {@link DeleteRuleCommandOutput} for command's `response` shape.
40
47
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {
61
68
  export declare class DeleteRuleCommand extends $Command<DeleteRuleCommandInput, DeleteRuleCommandOutput, EventBridgeClientResolvedConfig> {
62
69
  readonly input: DeleteRuleCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteRuleCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRuleCommandInput, DeleteRuleCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeApiDestinationRequest, DescribeApiDestinationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeApiDestinationCommand}.
8
10
  */
9
11
  export interface DescribeApiDestinationCommandInput extends DescribeApiDestinationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeApiDestinationCommand}.
13
17
  */
14
18
  export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details about an API destination.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeApiDestinationCommandInput - {@link DescribeApiDestinationCommandInput}
34
+ * @returns {@link DescribeApiDestinationCommandOutput}
28
35
  * @see {@link DescribeApiDestinationCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeApiDestinationCommandOutput} for command's `response` shape.
30
37
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat
40
47
  export declare class DescribeApiDestinationCommand extends $Command<DescribeApiDestinationCommandInput, DescribeApiDestinationCommandOutput, EventBridgeClientResolvedConfig> {
41
48
  readonly input: DescribeApiDestinationCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DescribeApiDestinationCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeApiDestinationCommandInput, DescribeApiDestinationCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeArchiveRequest, DescribeArchiveResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeArchiveCommand}.
8
10
  */
9
11
  export interface DescribeArchiveCommandInput extends DescribeArchiveRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeArchiveCommand}.
13
17
  */
14
18
  export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details about an archive.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeArchiveCommandInput - {@link DescribeArchiveCommandInput}
34
+ * @returns {@link DescribeArchiveCommandOutput}
28
35
  * @see {@link DescribeArchiveCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeArchiveCommandOutput} for command's `response` shape.
30
37
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _
43
50
  export declare class DescribeArchiveCommand extends $Command<DescribeArchiveCommandInput, DescribeArchiveCommandOutput, EventBridgeClientResolvedConfig> {
44
51
  readonly input: DescribeArchiveCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DescribeArchiveCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeArchiveCommandInput, DescribeArchiveCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeConnectionRequest, DescribeConnectionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeConnectionCommand}.
8
10
  */
9
11
  export interface DescribeConnectionCommandInput extends DescribeConnectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeConnectionCommand}.
13
17
  */
14
18
  export interface DescribeConnectionCommandOutput extends DescribeConnectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details about a connection.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeConnectionCommandInput - {@link DescribeConnectionCommandInput}
34
+ * @returns {@link DescribeConnectionCommandOutput}
28
35
  * @see {@link DescribeConnectionCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeConnectionCommandOutput} for command's `response` shape.
30
37
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
40
47
  export declare class DescribeConnectionCommand extends $Command<DescribeConnectionCommandInput, DescribeConnectionCommandOutput, EventBridgeClientResolvedConfig> {
41
48
  readonly input: DescribeConnectionCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DescribeConnectionCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeConnectionCommandInput, DescribeConnectionCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeEndpointRequest, DescribeEndpointResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEndpointCommand}.
8
10
  */
9
11
  export interface DescribeEndpointCommandInput extends DescribeEndpointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEndpointCommand}.
13
17
  */
14
18
  export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get the information about an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeEndpointCommandInput - {@link DescribeEndpointCommandInput}
34
+ * @returns {@link DescribeEndpointCommandOutput}
28
35
  * @see {@link DescribeEndpointCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeEndpointCommandOutput} for command's `response` shape.
30
37
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
40
47
  export declare class DescribeEndpointCommand extends $Command<DescribeEndpointCommandInput, DescribeEndpointCommandOutput, EventBridgeClientResolvedConfig> {
41
48
  readonly input: DescribeEndpointCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DescribeEndpointCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEndpointCommandInput, DescribeEndpointCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeEventBusRequest, DescribeEventBusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventBusCommand}.
8
10
  */
9
11
  export interface DescribeEventBusCommandInput extends DescribeEventBusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventBusCommand}.
13
17
  */
14
18
  export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Displays details about an event bus in your account. This can include the external Amazon Web Services
18
23
  * accounts that are permitted to write events to your default event bus, and the associated
19
24
  * policy. For custom event buses and partner event buses, it displays the name, ARN, policy,
@@ -31,6 +36,8 @@ export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse,
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DescribeEventBusCommandInput - {@link DescribeEventBusCommandInput}
40
+ * @returns {@link DescribeEventBusCommandOutput}
34
41
  * @see {@link DescribeEventBusCommandInput} for command's `input` shape.
35
42
  * @see {@link DescribeEventBusCommandOutput} for command's `response` shape.
36
43
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse,
46
53
  export declare class DescribeEventBusCommand extends $Command<DescribeEventBusCommandInput, DescribeEventBusCommandOutput, EventBridgeClientResolvedConfig> {
47
54
  readonly input: DescribeEventBusCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeEventBusCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventBusCommandInput, DescribeEventBusCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeEventSourceRequest, DescribeEventSourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventSourceCommand}.
8
10
  */
9
11
  export interface DescribeEventSourceCommandInput extends DescribeEventSourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventSourceCommand}.
13
17
  */
14
18
  export interface DescribeEventSourceCommandOutput extends DescribeEventSourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation lists details about a partner event source that is shared with your
18
23
  * account.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeEventSourceCommandInput - {@link DescribeEventSourceCommandInput}
35
+ * @returns {@link DescribeEventSourceCommandOutput}
29
36
  * @see {@link DescribeEventSourceCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeEventSourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes
44
51
  export declare class DescribeEventSourceCommand extends $Command<DescribeEventSourceCommandInput, DescribeEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
45
52
  readonly input: DescribeEventSourceCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DescribeEventSourceCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventSourceCommandInput, DescribeEventSourceCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribePartnerEventSourceRequest, DescribePartnerEventSourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePartnerEventSourceCommand}.
8
10
  */
9
11
  export interface DescribePartnerEventSourceCommandInput extends DescribePartnerEventSourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePartnerEventSourceCommand}.
13
17
  */
14
18
  export interface DescribePartnerEventSourceCommandOutput extends DescribePartnerEventSourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>An SaaS partner can use this operation to list details about a partner event source that
18
23
  * they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html">DescribeEventSource</a>
19
24
  * to see details about a partner event source that is
@@ -28,6 +33,8 @@ export interface DescribePartnerEventSourceCommandOutput extends DescribePartner
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribePartnerEventSourceCommandInput - {@link DescribePartnerEventSourceCommandInput}
37
+ * @returns {@link DescribePartnerEventSourceCommandOutput}
31
38
  * @see {@link DescribePartnerEventSourceCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribePartnerEventSourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribePartnerEventSourceCommandOutput extends DescribePartner
46
53
  export declare class DescribePartnerEventSourceCommand extends $Command<DescribePartnerEventSourceCommandInput, DescribePartnerEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
47
54
  readonly input: DescribePartnerEventSourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribePartnerEventSourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePartnerEventSourceCommandInput, DescribePartnerEventSourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeReplayRequest, DescribeReplayResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeReplayCommand}.
8
10
  */
9
11
  export interface DescribeReplayCommandInput extends DescribeReplayRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeReplayCommand}.
13
17
  */
14
18
  export interface DescribeReplayCommandOutput extends DescribeReplayResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details about a replay. Use <code>DescribeReplay</code> to determine the
18
23
  * progress of a running replay. A replay processes events to replay based on the time in the
19
24
  * event, and replays them using 1 minute intervals. If you use <code>StartReplay</code> and
@@ -33,6 +38,8 @@ export interface DescribeReplayCommandOutput extends DescribeReplayResponse, __M
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DescribeReplayCommandInput - {@link DescribeReplayCommandInput}
42
+ * @returns {@link DescribeReplayCommandOutput}
36
43
  * @see {@link DescribeReplayCommandInput} for command's `input` shape.
37
44
  * @see {@link DescribeReplayCommandOutput} for command's `response` shape.
38
45
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DescribeReplayCommandOutput extends DescribeReplayResponse, __M
48
55
  export declare class DescribeReplayCommand extends $Command<DescribeReplayCommandInput, DescribeReplayCommandOutput, EventBridgeClientResolvedConfig> {
49
56
  readonly input: DescribeReplayCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DescribeReplayCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeReplayCommandInput, DescribeReplayCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DescribeRuleRequest, DescribeRuleResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeRuleCommand}.
8
10
  */
9
11
  export interface DescribeRuleCommandInput extends DescribeRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeRuleCommand}.
13
17
  */
14
18
  export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the specified rule.</p>
18
23
  * <p>DescribeRule does not list the targets of a rule. To see the targets associated with a
19
24
  * rule, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
@@ -27,6 +32,8 @@ export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeRuleCommandInput - {@link DescribeRuleCommandInput}
36
+ * @returns {@link DescribeRuleCommandOutput}
30
37
  * @see {@link DescribeRuleCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeRuleCommandOutput} for command's `response` shape.
32
39
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __Metad
42
49
  export declare class DescribeRuleCommand extends $Command<DescribeRuleCommandInput, DescribeRuleCommandOutput, EventBridgeClientResolvedConfig> {
43
50
  readonly input: DescribeRuleCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeRuleCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRuleCommandInput, DescribeRuleCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { DisableRuleRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableRuleCommand}.
8
10
  */
9
11
  export interface DisableRuleCommandInput extends DisableRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableRuleCommand}.
13
17
  */
14
18
  export interface DisableRuleCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables the specified rule. A disabled rule won't match any events, and won't
18
23
  * self-trigger if it has a schedule expression.</p>
19
24
  * <p>When you disable a rule, incoming events might continue to match to the disabled rule.
@@ -28,6 +33,8 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DisableRuleCommandInput - {@link DisableRuleCommandInput}
37
+ * @returns {@link DisableRuleCommandOutput}
31
38
  * @see {@link DisableRuleCommandInput} for command's `input` shape.
32
39
  * @see {@link DisableRuleCommandOutput} for command's `response` shape.
33
40
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {
54
61
  export declare class DisableRuleCommand extends $Command<DisableRuleCommandInput, DisableRuleCommandOutput, EventBridgeClientResolvedConfig> {
55
62
  readonly input: DisableRuleCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DisableRuleCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableRuleCommandInput, DisableRuleCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
5
5
  import { EnableRuleRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableRuleCommand}.
8
10
  */
9
11
  export interface EnableRuleCommandInput extends EnableRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableRuleCommand}.
13
17
  */
14
18
  export interface EnableRuleCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
18
23
  * <p>When you enable a rule, incoming events might not immediately start matching to a newly
19
24
  * enabled rule. Allow a short period of time for changes to take effect.</p>
@@ -27,6 +32,8 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param EnableRuleCommandInput - {@link EnableRuleCommandInput}
36
+ * @returns {@link EnableRuleCommandOutput}
30
37
  * @see {@link EnableRuleCommandInput} for command's `input` shape.
31
38
  * @see {@link EnableRuleCommandOutput} for command's `response` shape.
32
39
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -53,11 +60,20 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {
53
60
  export declare class EnableRuleCommand extends $Command<EnableRuleCommandInput, EnableRuleCommandOutput, EventBridgeClientResolvedConfig> {
54
61
  readonly input: EnableRuleCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: EnableRuleCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableRuleCommandInput, EnableRuleCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }