@aws-sdk/client-apprunner 3.296.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 (49) hide show
  1. package/dist-types/AppRunner.d.ts +36 -0
  2. package/dist-types/AppRunnerClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateCustomDomainCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAutoScalingConfigurationCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateConnectionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateObservabilityConfigurationCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateServiceCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateVpcConnectorCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateVpcIngressConnectionCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteAutoScalingConfigurationCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteConnectionCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteObservabilityConfigurationCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteServiceCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteVpcConnectorCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteVpcIngressConnectionCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeAutoScalingConfigurationCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeCustomDomainsCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeObservabilityConfigurationCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeServiceCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeVpcConnectorCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeVpcIngressConnectionCommand.d.ts +16 -0
  22. package/dist-types/commands/DisassociateCustomDomainCommand.d.ts +16 -0
  23. package/dist-types/commands/ListAutoScalingConfigurationsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListConnectionsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListObservabilityConfigurationsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListOperationsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListServicesCommand.d.ts +16 -0
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  29. package/dist-types/commands/ListVpcConnectorsCommand.d.ts +16 -0
  30. package/dist-types/commands/ListVpcIngressConnectionsCommand.d.ts +16 -0
  31. package/dist-types/commands/PauseServiceCommand.d.ts +16 -0
  32. package/dist-types/commands/ResumeServiceCommand.d.ts +16 -0
  33. package/dist-types/commands/StartDeploymentCommand.d.ts +16 -0
  34. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  35. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  36. package/dist-types/commands/UpdateServiceCommand.d.ts +16 -0
  37. package/dist-types/commands/UpdateVpcIngressConnectionCommand.d.ts +16 -0
  38. package/dist-types/models/AppRunnerServiceException.d.ts +2 -0
  39. package/dist-types/models/models_0.d.ts +303 -0
  40. package/dist-types/pagination/DescribeCustomDomainsPaginator.d.ts +3 -0
  41. package/dist-types/pagination/Interfaces.d.ts +3 -0
  42. package/dist-types/pagination/ListAutoScalingConfigurationsPaginator.d.ts +3 -0
  43. package/dist-types/pagination/ListConnectionsPaginator.d.ts +3 -0
  44. package/dist-types/pagination/ListObservabilityConfigurationsPaginator.d.ts +3 -0
  45. package/dist-types/pagination/ListOperationsPaginator.d.ts +3 -0
  46. package/dist-types/pagination/ListServicesPaginator.d.ts +3 -0
  47. package/dist-types/pagination/ListVpcConnectorsPaginator.d.ts +3 -0
  48. package/dist-types/pagination/ListVpcIngressConnectionsPaginator.d.ts +3 -0
  49. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AppRunnerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppRunnerClient";
5
5
  import { ResumeServiceRequest, ResumeServiceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ResumeServiceCommand}.
8
10
  */
9
11
  export interface ResumeServiceCommandInput extends ResumeServiceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ResumeServiceCommand}.
13
17
  */
14
18
  export interface ResumeServiceCommandOutput extends ResumeServiceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Resume an active App Runner service. App Runner provisions compute capacity for the service.</p>
18
23
  * <p>This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a>ListOperations</a>
19
24
  * call to track the operation's progress.</p>
@@ -27,6 +32,8 @@ export interface ResumeServiceCommandOutput extends ResumeServiceResponse, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ResumeServiceCommandInput - {@link ResumeServiceCommandInput}
36
+ * @returns {@link ResumeServiceCommandOutput}
30
37
  * @see {@link ResumeServiceCommandInput} for command's `input` shape.
31
38
  * @see {@link ResumeServiceCommandOutput} for command's `response` shape.
32
39
  * @see {@link AppRunnerClientResolvedConfig | config} for AppRunnerClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ResumeServiceCommandOutput extends ResumeServiceResponse, __Met
48
55
  export declare class ResumeServiceCommand extends $Command<ResumeServiceCommandInput, ResumeServiceCommandOutput, AppRunnerClientResolvedConfig> {
49
56
  readonly input: ResumeServiceCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ResumeServiceCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppRunnerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ResumeServiceCommandInput, ResumeServiceCommandOutput>;
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 { AppRunnerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppRunnerClient";
5
5
  import { StartDeploymentRequest, StartDeploymentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartDeploymentCommand}.
8
10
  */
9
11
  export interface StartDeploymentCommandInput extends StartDeploymentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartDeploymentCommand}.
13
17
  */
14
18
  export interface StartDeploymentCommandOutput extends StartDeploymentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner
18
23
  * service.</p>
19
24
  * <p>For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker
@@ -30,6 +35,8 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResponse, _
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param StartDeploymentCommandInput - {@link StartDeploymentCommandInput}
39
+ * @returns {@link StartDeploymentCommandOutput}
33
40
  * @see {@link StartDeploymentCommandInput} for command's `input` shape.
34
41
  * @see {@link StartDeploymentCommandOutput} for command's `response` shape.
35
42
  * @see {@link AppRunnerClientResolvedConfig | config} for AppRunnerClient's `config` shape.
@@ -48,11 +55,20 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResponse, _
48
55
  export declare class StartDeploymentCommand extends $Command<StartDeploymentCommandInput, StartDeploymentCommandOutput, AppRunnerClientResolvedConfig> {
49
56
  readonly input: StartDeploymentCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: StartDeploymentCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppRunnerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDeploymentCommandInput, StartDeploymentCommandOutput>;
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 { AppRunnerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppRunnerClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.</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 TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link AppRunnerClientResolvedConfig | config} for AppRunnerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
46
53
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, AppRunnerClientResolvedConfig> {
47
54
  readonly input: TagResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: TagResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppRunnerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
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 { AppRunnerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppRunnerClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Remove tags from an App Runner resource.</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 UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link AppRunnerClientResolvedConfig | config} for AppRunnerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
46
53
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, AppRunnerClientResolvedConfig> {
47
54
  readonly input: UntagResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: UntagResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppRunnerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
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 { AppRunnerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppRunnerClient";
5
5
  import { UpdateServiceRequest, UpdateServiceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateServiceCommand}.
8
10
  */
9
11
  export interface UpdateServiceCommandInput extends UpdateServiceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateServiceCommand}.
13
17
  */
14
18
  export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto
18
23
  * scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service.
19
24
  * These can be set only when you create the service.</p>
@@ -30,6 +35,8 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdateServiceCommandInput - {@link UpdateServiceCommandInput}
39
+ * @returns {@link UpdateServiceCommandOutput}
33
40
  * @see {@link UpdateServiceCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdateServiceCommandOutput} for command's `response` shape.
35
42
  * @see {@link AppRunnerClientResolvedConfig | config} for AppRunnerClient's `config` shape.
@@ -51,11 +58,20 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
51
58
  export declare class UpdateServiceCommand extends $Command<UpdateServiceCommandInput, UpdateServiceCommandOutput, AppRunnerClientResolvedConfig> {
52
59
  readonly input: UpdateServiceCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: UpdateServiceCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppRunnerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateServiceCommandInput, UpdateServiceCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AppRunnerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppRunnerClient";
5
5
  import { UpdateVpcIngressConnectionRequest, UpdateVpcIngressConnectionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateVpcIngressConnectionCommand}.
8
10
  */
9
11
  export interface UpdateVpcIngressConnectionCommandInput extends UpdateVpcIngressConnectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateVpcIngressConnectionCommand}.
13
17
  */
14
18
  export interface UpdateVpcIngressConnectionCommandOutput extends UpdateVpcIngressConnectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:</p>
18
23
  * <ul>
19
24
  * <li>
@@ -42,6 +47,8 @@ export interface UpdateVpcIngressConnectionCommandOutput extends UpdateVpcIngres
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param UpdateVpcIngressConnectionCommandInput - {@link UpdateVpcIngressConnectionCommandInput}
51
+ * @returns {@link UpdateVpcIngressConnectionCommandOutput}
45
52
  * @see {@link UpdateVpcIngressConnectionCommandInput} for command's `input` shape.
46
53
  * @see {@link UpdateVpcIngressConnectionCommandOutput} for command's `response` shape.
47
54
  * @see {@link AppRunnerClientResolvedConfig | config} for AppRunnerClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateVpcIngressConnectionCommandOutput extends UpdateVpcIngres
63
70
  export declare class UpdateVpcIngressConnectionCommand extends $Command<UpdateVpcIngressConnectionCommandInput, UpdateVpcIngressConnectionCommandOutput, AppRunnerClientResolvedConfig> {
64
71
  readonly input: UpdateVpcIngressConnectionCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: UpdateVpcIngressConnectionCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppRunnerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateVpcIngressConnectionCommandInput, UpdateVpcIngressConnectionCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from AppRunner service.
4
6
  */
5
7
  export declare class AppRunnerServiceException extends __ServiceException {