@aws-sdk/client-proton 3.303.0 → 3.308.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.
- package/README.md +64 -0
- package/dist-cjs/Proton.js +120 -0
- package/dist-cjs/commands/CreateServiceInstanceCommand.js +46 -0
- package/dist-cjs/commands/CreateServiceSyncConfigCommand.js +45 -0
- package/dist-cjs/commands/DeleteServiceSyncConfigCommand.js +45 -0
- package/dist-cjs/commands/GetServiceInstanceSyncStatusCommand.js +45 -0
- package/dist-cjs/commands/GetServiceSyncBlockerSummaryCommand.js +45 -0
- package/dist-cjs/commands/GetServiceSyncConfigCommand.js +45 -0
- package/dist-cjs/commands/UpdateServiceSyncBlockerCommand.js +45 -0
- package/dist-cjs/commands/UpdateServiceSyncConfigCommand.js +45 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +25 -7
- package/dist-cjs/protocols/Aws_json1_0.js +671 -27
- package/dist-es/Proton.js +120 -0
- package/dist-es/commands/CreateServiceInstanceCommand.js +42 -0
- package/dist-es/commands/CreateServiceSyncConfigCommand.js +41 -0
- package/dist-es/commands/DeleteServiceSyncConfigCommand.js +41 -0
- package/dist-es/commands/GetServiceInstanceSyncStatusCommand.js +41 -0
- package/dist-es/commands/GetServiceSyncBlockerSummaryCommand.js +41 -0
- package/dist-es/commands/GetServiceSyncConfigCommand.js +41 -0
- package/dist-es/commands/UpdateServiceSyncBlockerCommand.js +41 -0
- package/dist-es/commands/UpdateServiceSyncConfigCommand.js +41 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +20 -4
- package/dist-es/protocols/Aws_json1_0.js +651 -23
- package/dist-types/Proton.d.ts +172 -75
- package/dist-types/ProtonClient.d.ts +10 -2
- package/dist-types/commands/CancelServiceInstanceDeploymentCommand.d.ts +10 -7
- package/dist-types/commands/CancelServicePipelineDeploymentCommand.d.ts +10 -7
- package/dist-types/commands/CreateComponentCommand.d.ts +1 -0
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -3
- package/dist-types/commands/CreateServiceInstanceCommand.d.ts +92 -0
- package/dist-types/commands/CreateServiceSyncConfigCommand.d.ts +86 -0
- package/dist-types/commands/CreateServiceTemplateCommand.d.ts +6 -5
- package/dist-types/commands/CreateServiceTemplateVersionCommand.d.ts +3 -2
- package/dist-types/commands/CreateTemplateSyncConfigCommand.d.ts +8 -6
- package/dist-types/commands/DeleteServiceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteServiceSyncConfigCommand.d.ts +81 -0
- package/dist-types/commands/DeleteServiceTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteServiceTemplateVersionCommand.d.ts +9 -6
- package/dist-types/commands/GetResourcesSummaryCommand.d.ts +13 -9
- package/dist-types/commands/GetServiceInstanceCommand.d.ts +2 -1
- package/dist-types/commands/GetServiceInstanceSyncStatusCommand.d.ts +79 -0
- package/dist-types/commands/GetServiceSyncBlockerSummaryCommand.d.ts +79 -0
- package/dist-types/commands/GetServiceSyncConfigCommand.d.ts +78 -0
- package/dist-types/commands/ListServiceInstancesCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/NotifyResourceDeploymentStatusChangeCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +4 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UpdateComponentCommand.d.ts +1 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +4 -2
- package/dist-types/commands/UpdateServiceInstanceCommand.d.ts +5 -3
- package/dist-types/commands/UpdateServicePipelineCommand.d.ts +14 -8
- package/dist-types/commands/UpdateServiceSyncBlockerCommand.d.ts +82 -0
- package/dist-types/commands/UpdateServiceSyncConfigCommand.d.ts +85 -0
- package/dist-types/commands/UpdateTemplateSyncConfigCommand.d.ts +3 -2
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +623 -148
- package/dist-types/protocols/Aws_json1_0.d.ts +24 -0
- package/dist-types/ts3.4/Proton.d.ts +136 -0
- package/dist-types/ts3.4/ProtonClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateServiceInstanceCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateServiceSyncConfigCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DeleteServiceSyncConfigCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetServiceInstanceSyncStatusCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetServiceSyncBlockerSummaryCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetServiceSyncConfigCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateServiceSyncBlockerCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateServiceSyncConfigCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +126 -9
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
- package/package.json +30 -30
|
@@ -19,20 +19,23 @@ export interface CancelServicePipelineDeploymentCommandOutput extends CancelServ
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>. For
|
|
23
|
+
* more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html">Update a service pipeline</a>
|
|
24
|
+
* in the <i>Proton User guide</i>.</p>
|
|
25
25
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
* <p>If the cancellation attempt succeeds, the resulting deployment state is
|
|
28
|
+
* <p>If the cancellation attempt succeeds, the resulting deployment state is
|
|
29
|
+
* <code>CANCELLED</code>.</p>
|
|
29
30
|
* </li>
|
|
30
31
|
* <li>
|
|
31
|
-
* <p>If the cancellation attempt fails, the resulting deployment state is
|
|
32
|
+
* <p>If the cancellation attempt fails, the resulting deployment state is
|
|
33
|
+
* <code>FAILED</code>.</p>
|
|
32
34
|
* </li>
|
|
33
35
|
* <li>
|
|
34
|
-
* <p>If the current <a>UpdateServicePipeline</a> action succeeds before the
|
|
35
|
-
*
|
|
36
|
+
* <p>If the current <a>UpdateServicePipeline</a> action succeeds before the
|
|
37
|
+
* cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and
|
|
38
|
+
* the cancellation attempt has no effect.</p>
|
|
36
39
|
* </li>
|
|
37
40
|
* </ul>
|
|
38
41
|
* @example
|
|
@@ -44,6 +44,7 @@ export interface CreateComponentCommandOutput extends CreateComponentOutput, __M
|
|
|
44
44
|
* value: "STRING_VALUE", // required
|
|
45
45
|
* },
|
|
46
46
|
* ],
|
|
47
|
+
* clientToken: "STRING_VALUE",
|
|
47
48
|
* };
|
|
48
49
|
* const command = new CreateComponentCommand(input);
|
|
49
50
|
* const response = await client.send(command);
|
|
@@ -19,9 +19,10 @@ export interface CreateServiceCommandOutput extends CreateServiceOutput, __Metad
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Create an Proton service. An Proton service is an instantiation of a service
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Create an Proton service. An Proton service is an instantiation of a service
|
|
23
|
+
* template and often includes several service instances and pipeline. For more information, see
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html">Services</a>
|
|
25
|
+
* in the <i>Proton User Guide</i>.</p>
|
|
25
26
|
* @example
|
|
26
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
28
|
* ```javascript
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { CreateServiceInstanceInput, CreateServiceInstanceOutput } from "../models/models_0";
|
|
5
|
+
import { ProtonClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ProtonClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link CreateServiceInstanceCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface CreateServiceInstanceCommandInput extends CreateServiceInstanceInput {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link CreateServiceInstanceCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateServiceInstanceCommandOutput extends CreateServiceInstanceOutput, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Create a service instance.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { ProtonClient, CreateServiceInstanceCommand } from "@aws-sdk/client-proton"; // ES Modules import
|
|
27
|
+
* // const { ProtonClient, CreateServiceInstanceCommand } = require("@aws-sdk/client-proton"); // CommonJS import
|
|
28
|
+
* const client = new ProtonClient(config);
|
|
29
|
+
* const input = { // CreateServiceInstanceInput
|
|
30
|
+
* name: "STRING_VALUE", // required
|
|
31
|
+
* serviceName: "STRING_VALUE", // required
|
|
32
|
+
* spec: "STRING_VALUE", // required
|
|
33
|
+
* templateMajorVersion: "STRING_VALUE",
|
|
34
|
+
* templateMinorVersion: "STRING_VALUE",
|
|
35
|
+
* tags: [ // TagList
|
|
36
|
+
* { // Tag
|
|
37
|
+
* key: "STRING_VALUE", // required
|
|
38
|
+
* value: "STRING_VALUE", // required
|
|
39
|
+
* },
|
|
40
|
+
* ],
|
|
41
|
+
* clientToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new CreateServiceInstanceCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param CreateServiceInstanceCommandInput - {@link CreateServiceInstanceCommandInput}
|
|
48
|
+
* @returns {@link CreateServiceInstanceCommandOutput}
|
|
49
|
+
* @see {@link CreateServiceInstanceCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link CreateServiceInstanceCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link ProtonClientResolvedConfig | config} for ProtonClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
+
* <p>There <i>isn't</i> sufficient access for performing this action.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ConflictException} (client fault)
|
|
57
|
+
* <p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServerException} (server fault)
|
|
60
|
+
* <p>The request failed to register with the service.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
+
* <p>The requested resource <i>wasn't</i> found.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
+
* <p>The request was denied due to request throttling.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ValidationException} (client fault)
|
|
69
|
+
* <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
*/
|
|
73
|
+
export declare class CreateServiceInstanceCommand extends $Command<CreateServiceInstanceCommandInput, CreateServiceInstanceCommandOutput, ProtonClientResolvedConfig> {
|
|
74
|
+
readonly input: CreateServiceInstanceCommandInput;
|
|
75
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
constructor(input: CreateServiceInstanceCommandInput);
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
83
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ProtonClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateServiceInstanceCommandInput, CreateServiceInstanceCommandOutput>;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
87
|
+
private serialize;
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
91
|
+
private deserialize;
|
|
92
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { CreateServiceSyncConfigInput, CreateServiceSyncConfigOutput } from "../models/models_0";
|
|
5
|
+
import { ProtonClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ProtonClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link CreateServiceSyncConfigCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface CreateServiceSyncConfigCommandInput extends CreateServiceSyncConfigInput {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link CreateServiceSyncConfigCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateServiceSyncConfigCommandOutput extends CreateServiceSyncConfigOutput, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Create the Proton Ops configuration file.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { ProtonClient, CreateServiceSyncConfigCommand } from "@aws-sdk/client-proton"; // ES Modules import
|
|
27
|
+
* // const { ProtonClient, CreateServiceSyncConfigCommand } = require("@aws-sdk/client-proton"); // CommonJS import
|
|
28
|
+
* const client = new ProtonClient(config);
|
|
29
|
+
* const input = { // CreateServiceSyncConfigInput
|
|
30
|
+
* serviceName: "STRING_VALUE", // required
|
|
31
|
+
* repositoryProvider: "STRING_VALUE", // required
|
|
32
|
+
* repositoryName: "STRING_VALUE", // required
|
|
33
|
+
* branch: "STRING_VALUE", // required
|
|
34
|
+
* filePath: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new CreateServiceSyncConfigCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @param CreateServiceSyncConfigCommandInput - {@link CreateServiceSyncConfigCommandInput}
|
|
41
|
+
* @returns {@link CreateServiceSyncConfigCommandOutput}
|
|
42
|
+
* @see {@link CreateServiceSyncConfigCommandInput} for command's `input` shape.
|
|
43
|
+
* @see {@link CreateServiceSyncConfigCommandOutput} for command's `response` shape.
|
|
44
|
+
* @see {@link ProtonClientResolvedConfig | config} for ProtonClient's `config` shape.
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
47
|
+
* <p>There <i>isn't</i> sufficient access for performing this action.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ConflictException} (client fault)
|
|
50
|
+
* <p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InternalServerException} (server fault)
|
|
53
|
+
* <p>The request failed to register with the service.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
56
|
+
* <p>A quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html">Proton Quotas</a> in
|
|
57
|
+
* the <i>Proton User Guide</i>.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
60
|
+
* <p>The request was denied due to request throttling.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ValidationException} (client fault)
|
|
63
|
+
* <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
|
|
64
|
+
*
|
|
65
|
+
*
|
|
66
|
+
*/
|
|
67
|
+
export declare class CreateServiceSyncConfigCommand extends $Command<CreateServiceSyncConfigCommandInput, CreateServiceSyncConfigCommandOutput, ProtonClientResolvedConfig> {
|
|
68
|
+
readonly input: CreateServiceSyncConfigCommandInput;
|
|
69
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
70
|
+
/**
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
constructor(input: CreateServiceSyncConfigCommandInput);
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ProtonClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateServiceSyncConfigCommandInput, CreateServiceSyncConfigCommandOutput>;
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
private serialize;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
private deserialize;
|
|
86
|
+
}
|
|
@@ -19,11 +19,12 @@ export interface CreateServiceTemplateCommandOutput extends CreateServiceTemplat
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Create a service template. The administrator creates a service template to define
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
22
|
+
* <p>Create a service template. The administrator creates a service template to define
|
|
23
|
+
* standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn,
|
|
24
|
+
* select the service template from Proton. If the selected service template includes a
|
|
25
|
+
* service pipeline definition, they provide a link to their source code repository. Proton
|
|
26
|
+
* then deploys and manages the infrastructure defined by the selected service template. For more
|
|
27
|
+
* information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html">Proton templates</a> in the <i>Proton User Guide</i>.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -19,8 +19,9 @@ export interface CreateServiceTemplateVersionCommandOutput extends CreateService
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Create a new major or minor version of a service template. A major version of a service
|
|
23
|
-
*
|
|
22
|
+
* <p>Create a new major or minor version of a service template. A major version of a service
|
|
23
|
+
* template is a version that <i>isn't</i> backward compatible. A minor version of
|
|
24
|
+
* a service template is a version that's backward compatible within its major version.</p>
|
|
24
25
|
* @example
|
|
25
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
27
|
* ```javascript
|
|
@@ -19,12 +19,14 @@ export interface CreateTemplateSyncConfigCommandOutput extends CreateTemplateSyn
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Set up a template to create new template versions automatically by tracking a linked
|
|
23
|
-
* repository is a repository that has been registered with Proton. For more
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
22
|
+
* <p>Set up a template to create new template versions automatically by tracking a linked
|
|
23
|
+
* repository. A linked repository is a repository that has been registered with Proton. For more
|
|
24
|
+
* information, see <a>CreateRepository</a>.</p>
|
|
25
|
+
* <p>When a commit is pushed to your linked repository, Proton checks for changes to your
|
|
26
|
+
* repository template bundles. If it detects a template bundle change, a new major or minor version
|
|
27
|
+
* of its template is created, if the version doesn’t already exist. For more information, see
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html">Template
|
|
29
|
+
* sync configurations</a> in the <i>Proton User Guide</i>.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
32
|
* ```javascript
|
|
@@ -21,7 +21,8 @@ export interface DeleteServiceCommandOutput extends DeleteServiceOutput, __Metad
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Delete a service, with its instances and pipeline.</p>
|
|
23
23
|
* <note>
|
|
24
|
-
* <p>You can't delete a service if it has any service instances that have components attached
|
|
24
|
+
* <p>You can't delete a service if it has any service instances that have components attached
|
|
25
|
+
* to them.</p>
|
|
25
26
|
* <p>For more information about components, see
|
|
26
27
|
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
27
28
|
* <i>Proton User Guide</i>.</p>
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DeleteServiceSyncConfigInput, DeleteServiceSyncConfigOutput } from "../models/models_0";
|
|
5
|
+
import { ProtonClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ProtonClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DeleteServiceSyncConfigCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DeleteServiceSyncConfigCommandInput extends DeleteServiceSyncConfigInput {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DeleteServiceSyncConfigCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DeleteServiceSyncConfigCommandOutput extends DeleteServiceSyncConfigOutput, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Delete the Proton Ops file.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { ProtonClient, DeleteServiceSyncConfigCommand } from "@aws-sdk/client-proton"; // ES Modules import
|
|
27
|
+
* // const { ProtonClient, DeleteServiceSyncConfigCommand } = require("@aws-sdk/client-proton"); // CommonJS import
|
|
28
|
+
* const client = new ProtonClient(config);
|
|
29
|
+
* const input = { // DeleteServiceSyncConfigInput
|
|
30
|
+
* serviceName: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
32
|
+
* const command = new DeleteServiceSyncConfigCommand(input);
|
|
33
|
+
* const response = await client.send(command);
|
|
34
|
+
* ```
|
|
35
|
+
*
|
|
36
|
+
* @param DeleteServiceSyncConfigCommandInput - {@link DeleteServiceSyncConfigCommandInput}
|
|
37
|
+
* @returns {@link DeleteServiceSyncConfigCommandOutput}
|
|
38
|
+
* @see {@link DeleteServiceSyncConfigCommandInput} for command's `input` shape.
|
|
39
|
+
* @see {@link DeleteServiceSyncConfigCommandOutput} for command's `response` shape.
|
|
40
|
+
* @see {@link ProtonClientResolvedConfig | config} for ProtonClient's `config` shape.
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
43
|
+
* <p>There <i>isn't</i> sufficient access for performing this action.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link ConflictException} (client fault)
|
|
46
|
+
* <p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link InternalServerException} (server fault)
|
|
49
|
+
* <p>The request failed to register with the service.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
52
|
+
* <p>The requested resource <i>wasn't</i> found.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
55
|
+
* <p>The request was denied due to request throttling.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ValidationException} (client fault)
|
|
58
|
+
* <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
|
|
59
|
+
*
|
|
60
|
+
*
|
|
61
|
+
*/
|
|
62
|
+
export declare class DeleteServiceSyncConfigCommand extends $Command<DeleteServiceSyncConfigCommandInput, DeleteServiceSyncConfigCommandOutput, ProtonClientResolvedConfig> {
|
|
63
|
+
readonly input: DeleteServiceSyncConfigCommandInput;
|
|
64
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
constructor(input: DeleteServiceSyncConfigCommandInput);
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ProtonClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteServiceSyncConfigCommandInput, DeleteServiceSyncConfigCommandOutput>;
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
76
|
+
private serialize;
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
80
|
+
private deserialize;
|
|
81
|
+
}
|
|
@@ -19,7 +19,8 @@ export interface DeleteServiceTemplateCommandOutput extends DeleteServiceTemplat
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>If no other major or minor versions of the service template exist, delete the service
|
|
22
|
+
* <p>If no other major or minor versions of the service template exist, delete the service
|
|
23
|
+
* template.</p>
|
|
23
24
|
* @example
|
|
24
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
26
|
* ```javascript
|
|
@@ -19,12 +19,15 @@ export interface DeleteServiceTemplateVersionCommandOutput extends DeleteService
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>If no other minor versions of a service template exist, delete a major version of the
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
22
|
+
* <p>If no other minor versions of a service template exist, delete a major version of the
|
|
23
|
+
* service template if it's not the <code>Recommended</code> version. Delete the
|
|
24
|
+
* <code>Recommended</code> version of the service template if no other major versions or minor
|
|
25
|
+
* versions of the service template exist. A major version of a service template is a version
|
|
26
|
+
* that <i>isn't</i> backwards compatible.</p>
|
|
27
|
+
* <p>Delete a minor version of a service template if it's not the <code>Recommended</code>
|
|
28
|
+
* version. Delete a <code>Recommended</code> minor version of the service template if no other
|
|
29
|
+
* minor versions of the service template exist. A minor version of a service template is a
|
|
30
|
+
* version that's backwards compatible.</p>
|
|
28
31
|
* @example
|
|
29
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
33
|
* ```javascript
|
|
@@ -20,15 +20,19 @@ export interface GetResourcesSummaryCommandOutput extends GetResourcesSummaryOut
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Get counts of Proton resources.</p>
|
|
23
|
-
* <p>For infrastructure-provisioning resources (environments, services, service instances,
|
|
24
|
-
* returns staleness counts. A resource is stale when it's behind the
|
|
25
|
-
* uses and it needs an update to become
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
23
|
+
* <p>For infrastructure-provisioning resources (environments, services, service instances,
|
|
24
|
+
* pipelines), the action returns staleness counts. A resource is stale when it's behind the
|
|
25
|
+
* recommended version of the Proton template that it uses and it needs an update to become
|
|
26
|
+
* current.</p>
|
|
27
|
+
* <p>The action returns staleness counts (counts of resources that are up-to-date, behind a
|
|
28
|
+
* template major version, or behind a template minor version), the total number of resources, and
|
|
29
|
+
* the number of resources that are in a failed state, grouped by resource type. Components,
|
|
30
|
+
* environments, and service templates return less information - see the <code>components</code>,
|
|
31
|
+
* <code>environments</code>, and <code>serviceTemplates</code> field descriptions.</p>
|
|
32
|
+
* <p>For context, the action also returns the total number of each type of Proton template in the
|
|
33
|
+
* Amazon Web Services account.</p>
|
|
34
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html">Proton dashboard</a> in the
|
|
35
|
+
* <i>Proton User Guide</i>.</p>
|
|
32
36
|
* @example
|
|
33
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
38
|
* ```javascript
|
|
@@ -19,7 +19,8 @@ export interface GetServiceInstanceCommandOutput extends GetServiceInstanceOutpu
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Get detailed data for a service instance. A service instance is an instantiation of
|
|
22
|
+
* <p>Get detailed data for a service instance. A service instance is an instantiation of
|
|
23
|
+
* service template and it runs in a specific environment.</p>
|
|
23
24
|
* @example
|
|
24
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
26
|
* ```javascript
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GetServiceInstanceSyncStatusInput, GetServiceInstanceSyncStatusOutput } from "../models/models_0";
|
|
5
|
+
import { ProtonClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ProtonClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetServiceInstanceSyncStatusCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetServiceInstanceSyncStatusCommandInput extends GetServiceInstanceSyncStatusInput {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetServiceInstanceSyncStatusCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetServiceInstanceSyncStatusCommandOutput extends GetServiceInstanceSyncStatusOutput, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Get the status of the synced service instance.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { ProtonClient, GetServiceInstanceSyncStatusCommand } from "@aws-sdk/client-proton"; // ES Modules import
|
|
27
|
+
* // const { ProtonClient, GetServiceInstanceSyncStatusCommand } = require("@aws-sdk/client-proton"); // CommonJS import
|
|
28
|
+
* const client = new ProtonClient(config);
|
|
29
|
+
* const input = { // GetServiceInstanceSyncStatusInput
|
|
30
|
+
* serviceName: "STRING_VALUE", // required
|
|
31
|
+
* serviceInstanceName: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
33
|
+
* const command = new GetServiceInstanceSyncStatusCommand(input);
|
|
34
|
+
* const response = await client.send(command);
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* @param GetServiceInstanceSyncStatusCommandInput - {@link GetServiceInstanceSyncStatusCommandInput}
|
|
38
|
+
* @returns {@link GetServiceInstanceSyncStatusCommandOutput}
|
|
39
|
+
* @see {@link GetServiceInstanceSyncStatusCommandInput} for command's `input` shape.
|
|
40
|
+
* @see {@link GetServiceInstanceSyncStatusCommandOutput} for command's `response` shape.
|
|
41
|
+
* @see {@link ProtonClientResolvedConfig | config} for ProtonClient's `config` shape.
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
44
|
+
* <p>There <i>isn't</i> sufficient access for performing this action.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InternalServerException} (server fault)
|
|
47
|
+
* <p>The request failed to register with the service.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
50
|
+
* <p>The requested resource <i>wasn't</i> found.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
53
|
+
* <p>The request was denied due to request throttling.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ValidationException} (client fault)
|
|
56
|
+
* <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
|
|
57
|
+
*
|
|
58
|
+
*
|
|
59
|
+
*/
|
|
60
|
+
export declare class GetServiceInstanceSyncStatusCommand extends $Command<GetServiceInstanceSyncStatusCommandInput, GetServiceInstanceSyncStatusCommandOutput, ProtonClientResolvedConfig> {
|
|
61
|
+
readonly input: GetServiceInstanceSyncStatusCommandInput;
|
|
62
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
constructor(input: GetServiceInstanceSyncStatusCommandInput);
|
|
67
|
+
/**
|
|
68
|
+
* @internal
|
|
69
|
+
*/
|
|
70
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ProtonClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetServiceInstanceSyncStatusCommandInput, GetServiceInstanceSyncStatusCommandOutput>;
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
74
|
+
private serialize;
|
|
75
|
+
/**
|
|
76
|
+
* @internal
|
|
77
|
+
*/
|
|
78
|
+
private deserialize;
|
|
79
|
+
}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GetServiceSyncBlockerSummaryInput, GetServiceSyncBlockerSummaryOutput } from "../models/models_0";
|
|
5
|
+
import { ProtonClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ProtonClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetServiceSyncBlockerSummaryCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetServiceSyncBlockerSummaryCommandInput extends GetServiceSyncBlockerSummaryInput {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetServiceSyncBlockerSummaryCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetServiceSyncBlockerSummaryCommandOutput extends GetServiceSyncBlockerSummaryOutput, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Get detailed data for the service sync blocker summary.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { ProtonClient, GetServiceSyncBlockerSummaryCommand } from "@aws-sdk/client-proton"; // ES Modules import
|
|
27
|
+
* // const { ProtonClient, GetServiceSyncBlockerSummaryCommand } = require("@aws-sdk/client-proton"); // CommonJS import
|
|
28
|
+
* const client = new ProtonClient(config);
|
|
29
|
+
* const input = { // GetServiceSyncBlockerSummaryInput
|
|
30
|
+
* serviceName: "STRING_VALUE", // required
|
|
31
|
+
* serviceInstanceName: "STRING_VALUE",
|
|
32
|
+
* };
|
|
33
|
+
* const command = new GetServiceSyncBlockerSummaryCommand(input);
|
|
34
|
+
* const response = await client.send(command);
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* @param GetServiceSyncBlockerSummaryCommandInput - {@link GetServiceSyncBlockerSummaryCommandInput}
|
|
38
|
+
* @returns {@link GetServiceSyncBlockerSummaryCommandOutput}
|
|
39
|
+
* @see {@link GetServiceSyncBlockerSummaryCommandInput} for command's `input` shape.
|
|
40
|
+
* @see {@link GetServiceSyncBlockerSummaryCommandOutput} for command's `response` shape.
|
|
41
|
+
* @see {@link ProtonClientResolvedConfig | config} for ProtonClient's `config` shape.
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
44
|
+
* <p>There <i>isn't</i> sufficient access for performing this action.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InternalServerException} (server fault)
|
|
47
|
+
* <p>The request failed to register with the service.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
50
|
+
* <p>The requested resource <i>wasn't</i> found.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
53
|
+
* <p>The request was denied due to request throttling.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ValidationException} (client fault)
|
|
56
|
+
* <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
|
|
57
|
+
*
|
|
58
|
+
*
|
|
59
|
+
*/
|
|
60
|
+
export declare class GetServiceSyncBlockerSummaryCommand extends $Command<GetServiceSyncBlockerSummaryCommandInput, GetServiceSyncBlockerSummaryCommandOutput, ProtonClientResolvedConfig> {
|
|
61
|
+
readonly input: GetServiceSyncBlockerSummaryCommandInput;
|
|
62
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
constructor(input: GetServiceSyncBlockerSummaryCommandInput);
|
|
67
|
+
/**
|
|
68
|
+
* @internal
|
|
69
|
+
*/
|
|
70
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ProtonClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetServiceSyncBlockerSummaryCommandInput, GetServiceSyncBlockerSummaryCommandOutput>;
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
74
|
+
private serialize;
|
|
75
|
+
/**
|
|
76
|
+
* @internal
|
|
77
|
+
*/
|
|
78
|
+
private deserialize;
|
|
79
|
+
}
|