• 沒有找到結果。

AWS Proton

N/A
N/A
Protected

Academic year: 2022

Share "AWS Proton"

Copied!
294
0
0

加載中.... (立即查看全文)

全文

(1)

AWS Proton

Welcome

API Version 2020-07-20

(2)

AWS Proton: Welcome

Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

(3)

Table of Contents

Welcome ... 1

Actions ... 4

AcceptEnvironmentAccountConnection ... 6

Request Syntax ... 6

Request Parameters ... 6

Response Syntax ... 6

Response Elements ... 6

Errors ... 7

See Also ... 7

CancelEnvironmentDeployment ... 8

Request Syntax ... 8

Request Parameters ... 8

Response Syntax ... 8

Response Elements ... 9

Errors ... 9

See Also ... 10

CancelServiceInstanceDeployment ... 11

Request Syntax ... 11

Request Parameters ... 11

Response Syntax ... 11

Response Elements ... 12

Errors ... 12

See Also ... 13

CancelServicePipelineDeployment ... 14

Request Syntax ... 14

Request Parameters ... 14

Response Syntax ... 14

Response Elements ... 15

Errors ... 15

See Also ... 15

CreateEnvironment ... 17

Request Syntax ... 17

Request Parameters ... 17

Response Syntax ... 19

Response Elements ... 20

Errors ... 20

See Also ... 21

CreateEnvironmentAccountConnection ... 22

Request Syntax ... 22

Request Parameters ... 22

Response Syntax ... 23

Response Elements ... 23

Errors ... 24

See Also ... 24

CreateEnvironmentTemplate ... 25

Request Syntax ... 25

Request Parameters ... 25

Response Syntax ... 26

Response Elements ... 27

Errors ... 27

See Also ... 27

CreateEnvironmentTemplateVersion ... 29

Request Syntax ... 29

Request Parameters ... 29

(4)

Response Syntax ... 30

Response Elements ... 30

Errors ... 31

See Also ... 31

CreateRepository ... 33

Request Syntax ... 33

Request Parameters ... 33

Response Syntax ... 34

Response Elements ... 34

Errors ... 34

See Also ... 35

CreateService ... 36

Request Syntax ... 36

Request Parameters ... 36

Response Syntax ... 38

Response Elements ... 38

Errors ... 39

See Also ... 39

CreateServiceTemplate ... 41

Request Syntax ... 41

Request Parameters ... 41

Response Syntax ... 42

Response Elements ... 42

Errors ... 43

See Also ... 43

CreateServiceTemplateVersion ... 45

Request Syntax ... 45

Request Parameters ... 45

Response Syntax ... 46

Response Elements ... 47

Errors ... 47

See Also ... 48

CreateTemplateSyncConfig ... 49

Request Syntax ... 49

Request Parameters ... 49

Response Syntax ... 50

Response Elements ... 50

Errors ... 50

See Also ... 51

DeleteEnvironment ... 52

Request Syntax ... 52

Request Parameters ... 52

Response Syntax ... 52

Response Elements ... 53

Errors ... 53

See Also ... 53

DeleteEnvironmentAccountConnection ... 55

Request Syntax ... 55

Request Parameters ... 55

Response Syntax ... 55

Response Elements ... 55

Errors ... 56

See Also ... 56

DeleteEnvironmentTemplate ... 58

Request Syntax ... 58

Request Parameters ... 58

Response Syntax ... 58

(5)

Response Elements ... 58

Errors ... 59

See Also ... 59

DeleteEnvironmentTemplateVersion ... 60

Request Syntax ... 60

Request Parameters ... 60

Response Syntax ... 61

Response Elements ... 61

Errors ... 61

See Also ... 62

DeleteRepository ... 63

Request Syntax ... 63

Request Parameters ... 63

Response Syntax ... 63

Response Elements ... 63

Errors ... 64

See Also ... 64

DeleteService ... 66

Request Syntax ... 66

Request Parameters ... 66

Response Syntax ... 66

Response Elements ... 67

Errors ... 67

See Also ... 67

DeleteServiceTemplate ... 69

Request Syntax ... 69

Request Parameters ... 69

Response Syntax ... 69

Response Elements ... 69

Errors ... 70

See Also ... 70

DeleteServiceTemplateVersion ... 71

Request Syntax ... 71

Request Parameters ... 71

Response Syntax ... 72

Response Elements ... 72

Errors ... 72

See Also ... 73

DeleteTemplateSyncConfig ... 74

Request Syntax ... 74

Request Parameters ... 74

Response Syntax ... 74

Response Elements ... 74

Errors ... 75

See Also ... 75

GetAccountSettings ... 77

Response Syntax ... 77

Response Elements ... 77

Errors ... 77

See Also ... 78

GetEnvironment ... 79

Request Syntax ... 79

Request Parameters ... 79

Response Syntax ... 79

Response Elements ... 80

Errors ... 80

See Also ... 80

(6)

GetEnvironmentAccountConnection ... 82

Request Syntax ... 82

Request Parameters ... 82

Response Syntax ... 82

Response Elements ... 82

Errors ... 83

See Also ... 83

GetEnvironmentTemplate ... 84

Request Syntax ... 84

Request Parameters ... 84

Response Syntax ... 84

Response Elements ... 84

Errors ... 85

See Also ... 85

GetEnvironmentTemplateVersion ... 86

Request Syntax ... 86

Request Parameters ... 86

Response Syntax ... 86

Response Elements ... 87

Errors ... 87

See Also ... 88

GetRepository ... 89

Request Syntax ... 89

Request Parameters ... 89

Response Syntax ... 89

Response Elements ... 89

Errors ... 90

See Also ... 90

GetRepositorySyncStatus ... 91

Request Syntax ... 91

Request Parameters ... 91

Response Syntax ... 92

Response Elements ... 92

Errors ... 92

See Also ... 93

GetService ... 94

Request Syntax ... 94

Request Parameters ... 94

Response Syntax ... 94

Response Elements ... 95

Errors ... 95

See Also ... 95

GetServiceInstance ... 97

Request Syntax ... 97

Request Parameters ... 97

Response Syntax ... 97

Response Elements ... 98

Errors ... 98

See Also ... 98

GetServiceTemplate ... 100

Request Syntax ... 100

Request Parameters ... 100

Response Syntax ... 100

Response Elements ... 100

Errors ... 101

See Also ... 101

GetServiceTemplateVersion ... 102

(7)

Request Syntax ... 102

Request Parameters ... 102

Response Syntax ... 102

Response Elements ... 103

Errors ... 103

See Also ... 104

GetTemplateSyncConfig ... 105

Request Syntax ... 105

Request Parameters ... 105

Response Syntax ... 105

Response Elements ... 105

Errors ... 106

See Also ... 106

GetTemplateSyncStatus ... 107

Request Syntax ... 107

Request Parameters ... 107

Response Syntax ... 107

Response Elements ... 108

Errors ... 109

See Also ... 109

ListEnvironmentAccountConnections ... 111

Request Syntax ... 111

Request Parameters ... 111

Response Syntax ... 112

Response Elements ... 112

Errors ... 112

See Also ... 113

ListEnvironmentOutputs ... 114

Request Syntax ... 114

Request Parameters ... 114

Response Syntax ... 114

Response Elements ... 114

Errors ... 115

See Also ... 115

ListEnvironmentProvisionedResources ... 117

Request Syntax ... 117

Request Parameters ... 117

Response Syntax ... 117

Response Elements ... 118

Errors ... 118

See Also ... 118

ListEnvironments ... 120

Request Syntax ... 120

Request Parameters ... 120

Response Syntax ... 120

Response Elements ... 121

Errors ... 121

See Also ... 122

ListEnvironmentTemplates ... 123

Request Syntax ... 123

Request Parameters ... 123

Response Syntax ... 123

Response Elements ... 124

Errors ... 124

See Also ... 124

ListEnvironmentTemplateVersions ... 126

Request Syntax ... 126

(8)

Request Parameters ... 126

Response Syntax ... 127

Response Elements ... 127

Errors ... 127

See Also ... 128

ListRepositories ... 129

Request Syntax ... 129

Request Parameters ... 129

Response Syntax ... 129

Response Elements ... 129

Errors ... 130

See Also ... 130

ListRepositorySyncDefinitions ... 132

Request Syntax ... 132

Request Parameters ... 132

Response Syntax ... 133

Response Elements ... 133

Errors ... 133

See Also ... 134

ListServiceInstanceOutputs ... 135

Request Syntax ... 135

Request Parameters ... 135

Response Syntax ... 135

Response Elements ... 136

Errors ... 136

See Also ... 137

ListServiceInstanceProvisionedResources ... 138

Request Syntax ... 138

Request Parameters ... 138

Response Syntax ... 138

Response Elements ... 139

Errors ... 139

See Also ... 140

ListServiceInstances ... 141

Request Syntax ... 141

Request Parameters ... 141

Response Syntax ... 141

Response Elements ... 142

Errors ... 142

See Also ... 143

ListServicePipelineOutputs ... 144

Request Syntax ... 144

Request Parameters ... 144

Response Syntax ... 144

Response Elements ... 144

Errors ... 145

See Also ... 145

ListServicePipelineProvisionedResources ... 147

Request Syntax ... 147

Request Parameters ... 147

Response Syntax ... 147

Response Elements ... 147

Errors ... 148

See Also ... 148

ListServices ... 150

Request Syntax ... 150

Request Parameters ... 150

(9)

Response Syntax ... 150

Response Elements ... 151

Errors ... 151

See Also ... 151

ListServiceTemplates ... 153

Request Syntax ... 153

Request Parameters ... 153

Response Syntax ... 153

Response Elements ... 154

Errors ... 154

See Also ... 154

ListServiceTemplateVersions ... 156

Request Syntax ... 156

Request Parameters ... 156

Response Syntax ... 157

Response Elements ... 157

Errors ... 157

See Also ... 158

ListTagsForResource ... 159

Request Syntax ... 159

Request Parameters ... 159

Response Syntax ... 159

Response Elements ... 160

Errors ... 160

See Also ... 160

NotifyResourceDeploymentStatusChange ... 162

Request Syntax ... 162

Request Parameters ... 162

Response Elements ... 163

Errors ... 163

See Also ... 164

RejectEnvironmentAccountConnection ... 165

Request Syntax ... 165

Request Parameters ... 165

Response Syntax ... 165

Response Elements ... 165

Errors ... 166

See Also ... 166

TagResource ... 168

Request Syntax ... 168

Request Parameters ... 168

Response Elements ... 168

Errors ... 168

See Also ... 169

UntagResource ... 170

Request Syntax ... 170

Request Parameters ... 170

Response Elements ... 170

Errors ... 170

See Also ... 171

UpdateAccountSettings ... 172

Request Syntax ... 172

Request Parameters ... 172

Response Syntax ... 172

Response Elements ... 173

Errors ... 173

See Also ... 173

(10)

UpdateEnvironment ... 175

Request Syntax ... 175

Request Parameters ... 176

Response Syntax ... 178

Response Elements ... 178

Errors ... 179

See Also ... 179

UpdateEnvironmentAccountConnection ... 180

Request Syntax ... 180

Request Parameters ... 180

Response Syntax ... 180

Response Elements ... 181

Errors ... 181

See Also ... 181

UpdateEnvironmentTemplate ... 183

Request Syntax ... 183

Request Parameters ... 183

Response Syntax ... 183

Response Elements ... 184

Errors ... 184

See Also ... 185

UpdateEnvironmentTemplateVersion ... 186

Request Syntax ... 186

Request Parameters ... 186

Response Syntax ... 187

Response Elements ... 187

Errors ... 187

See Also ... 188

UpdateService ... 189

Request Syntax ... 189

Request Parameters ... 189

Response Syntax ... 190

Response Elements ... 190

Errors ... 190

See Also ... 191

UpdateServiceInstance ... 192

Request Syntax ... 192

Request Parameters ... 192

Response Syntax ... 194

Response Elements ... 194

Errors ... 194

See Also ... 195

UpdateServicePipeline ... 196

Request Syntax ... 196

Request Parameters ... 196

Response Syntax ... 198

Response Elements ... 198

Errors ... 198

See Also ... 199

UpdateServiceTemplate ... 200

Request Syntax ... 200

Request Parameters ... 200

Response Syntax ... 200

Response Elements ... 201

Errors ... 201

See Also ... 202

UpdateServiceTemplateVersion ... 203

(11)

Request Syntax ... 203

Request Parameters ... 203

Response Syntax ... 204

Response Elements ... 204

Errors ... 205

See Also ... 205

UpdateTemplateSyncConfig ... 207

Request Syntax ... 207

Request Parameters ... 207

Response Syntax ... 208

Response Elements ... 208

Errors ... 208

See Also ... 209

Data Types ... 210

AccountSettings ... 212

Contents ... 212

See Also ... 212

CompatibleEnvironmentTemplate ... 213

Contents ... 213

See Also ... 213

CompatibleEnvironmentTemplateInput ... 214

Contents ... 214

See Also ... 214

Environment ... 215

Contents ... 215

See Also ... 217

EnvironmentAccountConnection ... 218

Contents ... 218

See Also ... 219

EnvironmentAccountConnectionSummary ... 220

Contents ... 220

See Also ... 221

EnvironmentSummary ... 222

Contents ... 222

See Also ... 224

EnvironmentTemplate ... 225

Contents ... 225

See Also ... 226

EnvironmentTemplateFilter ... 227

Contents ... 227

See Also ... 227

EnvironmentTemplateSummary ... 228

Contents ... 228

See Also ... 229

EnvironmentTemplateVersion ... 230

Contents ... 230

See Also ... 231

EnvironmentTemplateVersionSummary ... 233

Contents ... 233

See Also ... 234

Output ... 235

Contents ... 235

See Also ... 235

ProvisionedResource ... 236

Contents ... 236

See Also ... 236

Repository ... 237

(12)

Contents ... 237

See Also ... 237

RepositoryBranch ... 239

Contents ... 239

See Also ... 239

RepositoryBranchInput ... 241

Contents ... 241

See Also ... 241

RepositorySummary ... 242

Contents ... 242

See Also ... 242

RepositorySyncAttempt ... 243

Contents ... 243

See Also ... 243

RepositorySyncDefinition ... 244

Contents ... 244

See Also ... 244

RepositorySyncEvent ... 245

Contents ... 245

See Also ... 245

ResourceSyncAttempt ... 246

Contents ... 246

See Also ... 246

ResourceSyncEvent ... 248

Contents ... 248

See Also ... 248

Revision ... 249

Contents ... 249

See Also ... 249

S3ObjectSource ... 251

Contents ... 251

See Also ... 251

Service ... 252

Contents ... 252

See Also ... 254

ServiceInstance ... 255

Contents ... 255

See Also ... 257

ServiceInstanceSummary ... 258

Contents ... 258

See Also ... 260

ServicePipeline ... 261

Contents ... 261

See Also ... 262

ServiceSummary ... 263

Contents ... 263

See Also ... 264

ServiceTemplate ... 265

Contents ... 265

See Also ... 266

ServiceTemplateSummary ... 267

Contents ... 267

See Also ... 268

ServiceTemplateVersion ... 269

Contents ... 269

See Also ... 270

ServiceTemplateVersionSummary ... 272

(13)

Contents ... 272

See Also ... 273

Tag ... 274

Contents ... 274

See Also ... 274

TemplateSyncConfig ... 275

Contents ... 275

See Also ... 276

TemplateVersionSourceInput ... 277

Contents ... 277

See Also ... 277

Common Parameters ... 278

Common Errors ... 280

(14)

Welcome

This is the AWS Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the AWS Proton service.

The documentation for each action shows the Query API request parameters and the XML response.

Alternatively, you can use the AWS CLI to access an API. For more information, see the AWS Command Line Interface User Guide.

The AWS Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.

Because administrators define the infrastructure and tooling that AWS Proton deploys and manages, they need permissions to use all of the listed API operations.

When developers select a specific infrastructure and tooling set, AWS Proton deploys their applications.

To monitor their applications that are running on AWS Proton, developers need permissions to the service create, list, update and delete API operations and the service instance list and update API operations.

To learn more about AWS Proton administration, see the AWS Proton Administrator Guide.

To learn more about deploying serverless and containerized applications on AWS Proton, see the AWS Proton User Guide.

Ensuring Idempotency

When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.

Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete

successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.

The following lists of APIs are grouped according to methods that ensure idempotency.

Idempotent create APIs with a client token

The API actions in this list support idempotency with the use of a client token. The corresponding AWS CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.

Given a request action that has succeeded:

(15)

If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.

If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a ValidationException with an IdempotentParameterMismatch error.

Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.

If the original resource is deleted and you retry the request, a new resource is created.

Idempotent create APIs with a client token:

• CreateEnvironmentTemplateVersion

• CreateServiceTemplateVersion

• CreateEnvironmentAccountConnection

Idempotent create APIs

Given a request action that has succeeded:

If you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.

If the original resource has been modified, the retry throws a ConflictException.

If you retry with different input parameters, the retry throws a ValidationException with an IdempotentParameterMismatch error.

Idempotent create APIs:

• CreateEnvironmentTemplate

• CreateServiceTemplate

• CreateEnvironment

• CreateService

Idempotent delete APIs

Given a request action that has succeeded:

When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.

If you retry and the resource doesn't exist, the response is empty.

In both cases, the retry succeeds.

Idempotent delete APIs:

• DeleteEnvironmentTemplate

• DeleteEnvironmentTemplateVersion

• DeleteServiceTemplate

• DeleteServiceTemplateVersion

• DeleteEnvironmentAccountConnection

(16)

Asynchronous idempotent delete APIs Given a request action that has succeeded:

If you retry the request with an API from this group, if the original request delete operation status is DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any further actions.

If the original request delete operation is complete, a retry returns an empty response.

Asynchronous idempotent delete APIs:

• DeleteEnvironment

• DeleteService

This document was last published on March 6, 2022.

(17)

Actions

The following actions are supported:

• AcceptEnvironmentAccountConnection (p. 6)

• CancelEnvironmentDeployment (p. 8)

• CancelServiceInstanceDeployment (p. 11)

• CancelServicePipelineDeployment (p. 14)

• CreateEnvironment (p. 17)

• CreateEnvironmentAccountConnection (p. 22)

• CreateEnvironmentTemplate (p. 25)

• CreateEnvironmentTemplateVersion (p. 29)

• CreateRepository (p. 33)

• CreateService (p. 36)

• CreateServiceTemplate (p. 41)

• CreateServiceTemplateVersion (p. 45)

• CreateTemplateSyncConfig (p. 49)

• DeleteEnvironment (p. 52)

• DeleteEnvironmentAccountConnection (p. 55)

• DeleteEnvironmentTemplate (p. 58)

• DeleteEnvironmentTemplateVersion (p. 60)

• DeleteRepository (p. 63)

• DeleteService (p. 66)

• DeleteServiceTemplate (p. 69)

• DeleteServiceTemplateVersion (p. 71)

• DeleteTemplateSyncConfig (p. 74)

• GetAccountSettings (p. 77)

• GetEnvironment (p. 79)

• GetEnvironmentAccountConnection (p. 82)

• GetEnvironmentTemplate (p. 84)

• GetEnvironmentTemplateVersion (p. 86)

• GetRepository (p. 89)

• GetRepositorySyncStatus (p. 91)

• GetService (p. 94)

• GetServiceInstance (p. 97)

• GetServiceTemplate (p. 100)

• GetServiceTemplateVersion (p. 102)

• GetTemplateSyncConfig (p. 105)

• GetTemplateSyncStatus (p. 107)

• ListEnvironmentAccountConnections (p. 111)

• ListEnvironmentOutputs (p. 114)

• ListEnvironmentProvisionedResources (p. 117)

• ListEnvironments (p. 120)

• ListEnvironmentTemplates (p. 123)

(18)

• ListEnvironmentTemplateVersions (p. 126)

• ListRepositories (p. 129)

• ListRepositorySyncDefinitions (p. 132)

• ListServiceInstanceOutputs (p. 135)

• ListServiceInstanceProvisionedResources (p. 138)

• ListServiceInstances (p. 141)

• ListServicePipelineOutputs (p. 144)

• ListServicePipelineProvisionedResources (p. 147)

• ListServices (p. 150)

• ListServiceTemplates (p. 153)

• ListServiceTemplateVersions (p. 156)

• ListTagsForResource (p. 159)

• NotifyResourceDeploymentStatusChange (p. 162)

• RejectEnvironmentAccountConnection (p. 165)

• TagResource (p. 168)

• UntagResource (p. 170)

• UpdateAccountSettings (p. 172)

• UpdateEnvironment (p. 175)

• UpdateEnvironmentAccountConnection (p. 180)

• UpdateEnvironmentTemplate (p. 183)

• UpdateEnvironmentTemplateVersion (p. 186)

• UpdateService (p. 189)

• UpdateServiceInstance (p. 192)

• UpdateServicePipeline (p. 196)

• UpdateServiceTemplate (p. 200)

• UpdateServiceTemplateVersion (p. 203)

• UpdateTemplateSyncConfig (p. 207)

(19)

AcceptEnvironmentAccountConnection

AcceptEnvironmentAccountConnection

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

For more information, see Environment account connections in the AWS Proton Administrator guide.

Request Syntax

{ "id": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

id (p. 6)

The ID of the environment account connection.

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Response Syntax

{ "environmentAccountConnection": { "arn": "string",

"environmentAccountId": "string", "environmentName": "string", "id": "string",

"lastModifiedAt": number, "managementAccountId": "string", "requestedAt": number,

"roleArn": "string", "status": "string"

} }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environmentAccountConnection (p. 6)

The environment account connection data that's returned by AWS Proton.

(20)

Errors

Type: EnvironmentAccountConnection (p. 218) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(21)

CancelEnvironmentDeployment

CancelEnvironmentDeployment

Attempts to cancel an environment deployment on an UpdateEnvironment (p. 175) action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the AWS Proton Administrator guide.

The following list includes potential cancellation scenarios.

• If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

• If the cancellation attempt fails, the resulting deployment state is FAILED.

• If the current UpdateEnvironment (p. 175) action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Request Syntax

{

"environmentName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

environmentName (p. 8)

The name of the environment with the deployment to cancel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

Response Syntax

{ "environment": { "arn": "string", "createdAt": number,

"deploymentStatus": "string",

"deploymentStatusMessage": "string", "description": "string",

"environmentAccountConnectionId": "string", "environmentAccountId": "string",

"lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "name": "string",

"protonServiceRoleArn": "string", "provisioning": "string",

(22)

Response Elements

"provisioningRepository": { "arn": "string",

"branch": "string", "name": "string", "provider": "string"

},

"spec": "string",

"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"

} }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environment (p. 8)

The environment summary data that's returned by AWS Proton.

Type: Environment (p. 215) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

(23)

See Also

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(24)

CancelServiceInstanceDeployment

CancelServiceInstanceDeployment

Attempts to cancel a service instance deployment on an UpdateServiceInstance (p. 192) action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the AWS Proton Administrator guide or the AWS Proton User guide.

The following list includes potential cancellation scenarios.

• If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

• If the cancellation attempt fails, the resulting deployment state is FAILED.

• If the current UpdateServiceInstance (p. 192) action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Request Syntax

{ "serviceInstanceName": "string", "serviceName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

serviceInstanceName (p. 11)

The name of the service instance with the deployment to cancel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes serviceName (p. 11)

The name of the service with the service instance deployment to cancel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

Response Syntax

{

(25)

Response Elements

"serviceInstance": { "arn": "string", "createdAt": number,

"deploymentStatus": "string",

"deploymentStatusMessage": "string", "environmentName": "string",

"lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "name": "string",

"serviceName": "string", "spec": "string",

"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

serviceInstance (p. 11)

The service instance summary data that's returned by AWS Proton.

Type: ServiceInstance (p. 255) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

(26)

See Also

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(27)

CancelServicePipelineDeployment

CancelServicePipelineDeployment

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline (p. 196) action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the AWS Proton Administrator guide or the AWS Proton User guide.

The following list includes potential cancellation scenarios.

• If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

• If the cancellation attempt fails, the resulting deployment state is FAILED.

• If the current UpdateServicePipeline (p. 196) action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Request Syntax

{

"serviceName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

serviceName (p. 14)

The name of the service with the service pipeline deployment to cancel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

Response Syntax

{

"pipeline": { "arn": "string", "createdAt": number,

"deploymentStatus": "string",

"deploymentStatusMessage": "string", "lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "spec": "string",

"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"

}}

(28)

Response Elements

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipeline (p. 14)

The service pipeline detail data that's returned by AWS Proton.

Type: ServicePipeline (p. 261) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

(29)

See Also

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(30)

CreateEnvironment

CreateEnvironment

Deploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

• Standard provisioning: AWS Proton makes direct calls to provision your resources.

• Pull request provisioning: AWS Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.

For more information, see the Environments in the AWS Proton Administrator Guide.

Request Syntax

{ "description": "string",

"environmentAccountConnectionId": "string", "name": "string",

"protonServiceRoleArn": "string", "provisioningRepository": { "branch": "string", "name": "string", "provider": "string"

},

"spec": "string", "tags": [ {

"key": "string", "value": "string"

} ],

"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

description (p. 17)

A description of the environment that's being created and deployed.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

environmentAccountConnectionId (p. 17)

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the

(31)

Request Parameters

environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter and values. For more information, see Environment account connections in the AWS Proton Administrator guide.

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: No name (p. 17)

The name of the environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

protonServiceRoleArn (p. 17)

The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You must include either the

environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter when you use standard provisioning.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

provisioningRepository (p. 17)

The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

Important

Provisioning by pull request is currently in feature preview and is only usable with Terraform based AWS Proton Templates. To learn more about AWS Feature Preview terms, see section 2 on Beta and Previews.

Type: RepositoryBranchInput (p. 241) object Required: No

spec (p. 17)

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the AWS Proton Administrator Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51200.

Required: Yes tags (p. 17)

Create tags for your environment. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

Type: Array of Tag (p. 274) objects

(32)

Response Syntax

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

templateMajorVersion (p. 17)

The major version of the environment template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^(0|([1-9]{1}\d*))$

Required: Yes

templateMinorVersion (p. 17)

The minor version of the environment template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^(0|([1-9]{1}\d*))$

Required: No templateName (p. 17)

The name of the environment template. For more information, see Environment Templates in the AWS Proton Administrator Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

Response Syntax

{ "environment": { "arn": "string", "createdAt": number,

"deploymentStatus": "string",

"deploymentStatusMessage": "string", "description": "string",

"environmentAccountConnectionId": "string", "environmentAccountId": "string",

"lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "name": "string",

"protonServiceRoleArn": "string", "provisioning": "string",

"provisioningRepository": { "arn": "string",

"branch": "string", "name": "string", "provider": "string"

},

(33)

Response Elements

"spec": "string",

"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environment (p. 19)

The environment detail data that's returned by AWS Proton.

Type: Environment (p. 215) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400 ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

(34)

See Also

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(35)

CreateEnvironmentAccountConnection

CreateEnvironmentAccountConnection

Create an environment account connection in an environment account so that environment

infrastructure resources can be provisioned in the environment account from a management account.

An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the AWS Proton Administrator guide.

Request Syntax

{ "clientToken": "string", "environmentName": "string", "managementAccountId": "string", "roleArn": "string",

"tags": [ {

"key": "string", "value": "string"

} ]}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

clientToken (p. 22)

When included, if two identical requests are made with the same client token, AWS Proton returns the environment account connection that the first request created.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: ^[!-~]*$

Required: No

environmentName (p. 22)

The name of the AWS Proton environment that's created in the associated management account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

managementAccountId (p. 22)

The ID of the management account that accepts or rejects the environment account connection.

You create and manage the AWS Proton environment in this account. If the management account

(36)

Response Syntax

accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

Type: String Pattern: ^\d{12}$

Required: Yes roleArn (p. 22)

The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account.

AWS Proton uses this role to provision infrastructure resources in the associated environment account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes tags (p. 22)

Tags for your environment account connection. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide.

Type: Array of Tag (p. 274) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax

{ "environmentAccountConnection": { "arn": "string",

"environmentAccountId": "string", "environmentName": "string", "id": "string",

"lastModifiedAt": number, "managementAccountId": "string", "requestedAt": number,

"roleArn": "string", "status": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environmentAccountConnection (p. 23)

The environment account connection detail data that's returned by AWS Proton.

Type: EnvironmentAccountConnection (p. 218) object

(37)

Errors

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(38)

CreateEnvironmentTemplate

CreateEnvironmentTemplate

Create an environment template for AWS Proton. For more information, see Environment Templates in the AWS Proton Administrator Guide.

You can create an environment template in one of the two following ways:

• Register and publish a standard environment template that instructs AWS Proton to deploy and manage environment infrastructure.

• Register and publish a customer managed environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the AWS Proton Administrator Guide.

Request Syntax

{

"description": "string", "displayName": "string", "encryptionKey": "string", "name": "string",

"provisioning": "string", "tags": [

{

"key": "string", "value": "string"

} ]}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

description (p. 25)

A description of the environment template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No displayName (p. 25)

The environment template name as displayed in the developer interface.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

(39)

Response Syntax

Required: No encryptionKey (p. 25)

A customer provided encryption key that AWS Proton uses to encrypt data.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No name (p. 25)

The name of the environment template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes provisioning (p. 25)

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

Type: String

Valid Values: CUSTOMER_MANAGED Required: No

tags (p. 25)

Create tags for your environment template. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

Type: Array of Tag (p. 274) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax

{ "environmentTemplate": { "arn": "string", "createdAt": number, "description": "string", "displayName": "string", "encryptionKey": "string", "lastModifiedAt": number, "name": "string",

"provisioning": "string", "recommendedVersion": "string"

}}

(40)

Response Elements

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environmentTemplate (p. 26)

The environment template detail data that's returned by AWS Proton.

Type: EnvironmentTemplate (p. 225) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

(41)

See Also

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(42)

CreateEnvironmentTemplateVersion

CreateEnvironmentTemplateVersion

Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.

Request Syntax

{ "clientToken": "string", "description": "string", "majorVersion": "string", "source": {

"s3": {

"bucket": "string", "key": "string"

} },

"tags": [ {

"key": "string", "value": "string"

} ],

"templateName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

clientToken (p. 29)

When included, if two identical requests are made with the same client token, AWS Proton returns the environment template version that the first request created.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: ^[!-~]*$

Required: No description (p. 29)

A description of the new version of an environment template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No majorVersion (p. 29)

To create a new minor version of the environment template, include major Version.

(43)

Response Syntax

To create a new major and minor version of the environment template, exclude major Version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^(0|([1-9]{1}\d*))$

Required: No source (p. 29)

An object that includes the template bundle S3 bucket path and name for the new version of an template.

Type: TemplateVersionSourceInput (p. 277) object Required: Yes

tags (p. 29)

Create tags for a new version of an environment template.

Type: Array of Tag (p. 274) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No templateName (p. 29)

The name of the environment template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

Response Syntax

{ "environmentTemplateVersion": { "arn": "string",

"createdAt": number, "description": "string", "lastModifiedAt": number, "majorVersion": "string", "minorVersion": "string",

"recommendedMinorVersion": "string", "schema": "string",

"status": "string",

"statusMessage": "string", "templateName": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

(44)

Errors

The following data is returned in JSON format by the service.

environmentTemplateVersion (p. 30)

The environment template detail data that's returned by AWS Proton.

Type: EnvironmentTemplateVersion (p. 230) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400 ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

HTTP Status Code: 400 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

(45)

See Also

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(46)

CreateRepository

CreateRepository

Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see Template bundles and Template sync configurations in the AWS Proton Administrator Guide. When you create a repository link, AWS Proton creates a service linked role for you.

Request Syntax

{

"connectionArn": "string", "encryptionKey": "string", "name": "string",

"provider": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

connectionArn (p. 33)

The Amazon Resource Name (ARN) of your AWS CodeStar connection. For more information, see Setting up for AWS Proton in the AWS Proton Administrator Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes encryptionKey (p. 33)

The ARN of your customer AWS Key Management Service (AWS KMS) key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No name (p. 33)

The repository name (for example, myrepos/myrepo).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*

Required: Yes provider (p. 33)

The repository provider.

(47)

Response Syntax

Type: String

Valid Values: GITHUB | GITHUB_ENTERPRISE | BITBUCKET Required: Yes

Response Syntax

{ "repository": { "arn": "string",

"connectionArn": "string", "encryptionKey": "string", "name": "string",

"provider": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

repository (p. 34)

The repository detail data that's returned by AWS Proton.

Type: Repository (p. 237) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 280).

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400 ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400 InternalServerException

The request failed to register with the service.

HTTP Status Code: 500 ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

HTTP Status Code: 400

(48)

See Also

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(49)

CreateService

CreateService

Create an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the AWS Proton Administrator Guide and Services in the AWS Proton User Guide.

Request Syntax

{

"branchName": "string", "description": "string", "name": "string",

"repositoryConnectionArn": "string", "repositoryId": "string",

"spec": "string", "tags": [ {

"key": "string", "value": "string"

} ],

"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 278).

The request accepts the following data in JSON format.

branchName (p. 36)

The name of the code repository branch that holds the code that's deployed in AWS Proton. Don't include this parameter if your service template doesn't include a service pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No description (p. 36)

A description of the AWS Proton service.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No name (p. 36)

The service name.

Type: String

參考文獻

相關文件

了⼀一個方案,用以尋找滿足 Calabi 方程的空 間,這些空間現在通稱為 Calabi-Yau 空間。.

• ‘ content teachers need to support support the learning of those parts of language knowledge that students are missing and that may be preventing them mastering the

Robinson Crusoe is an Englishman from the 1) t_______ of York in the seventeenth century, the youngest son of a merchant of German origin. This trip is financially successful,

fostering independent application of reading strategies Strategy 7: Provide opportunities for students to track, reflect on, and share their learning progress (destination). •

Courtesy: Ned Wright’s Cosmology Page Burles, Nolette & Turner, 1999?. Total Mass Density

•  What if the quark bilinear is slightly away from the light cone (space-like) in the proton

2-1 註冊為會員後您便有了個別的”my iF”帳戶。完成註冊後請點選左方 Register entry (直接登入 my iF 則直接進入下方畫面),即可選擇目前開放可供參賽的獎項,找到iF STUDENT

Following the supply by the school of a copy of personal data in compliance with a data access request, the requestor is entitled to ask for correction of the personal data