2023/07/13 - AWS Proton - 3 new 27 updated api methods
Changes This release adds support for deployment history for Proton provisioned resources
List deployments. You can filter the result list by environment, service, or a single service instance.
See also: AWS API Documentation
Request Syntax
client.list_deployments(
componentName='string',
environmentName='string',
maxResults=123,
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
string
The name of a component for result list filtering. Proton returns deployments associated with that component.
string
The name of an environment for result list filtering. Proton returns deployments associated with the environment.
integer
The maximum number of deployments to list.
string
A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously requested.
string
The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.
string
The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.
dict
Response Syntax
{
'deployments': [
{
'arn': 'string',
'completedAt': datetime(2015, 1, 1),
'componentName': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'environmentName': 'string',
'id': 'string',
'lastAttemptedDeploymentId': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'targetArn': 'string',
'targetResourceCreatedAt': datetime(2015, 1, 1),
'targetResourceType': 'ENVIRONMENT'|'SERVICE_PIPELINE'|'SERVICE_INSTANCE'|'COMPONENT'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
deployments (list) --
An array of deployment with summary data.
(dict) --
Summary data of the deployment.
arn (string) --
The Amazon Resource Name (ARN) of the deployment.
completedAt (datetime) --
The date and time the deployment was completed.
componentName (string) --
The name of the component associated with the deployment.
createdAt (datetime) --
The date and time the deployment was created.
deploymentStatus (string) --
The current status of the deployment.
environmentName (string) --
The name of the environment associated with the deployment.
id (string) --
The ID of the deployment.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment.
lastModifiedAt (datetime) --
The date and time the deployment was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment.
serviceInstanceName (string) --
The name of the service instance associated with the deployment.
serviceName (string) --
The name of the service associated with the deployment.
targetArn (string) --
The Amazon Resource Name (ARN) of the target of the deployment.
targetResourceCreatedAt (datetime) --
The date and time the target resource was created.
targetResourceType (string) --
The resource type of the deployment target. It can be an environment, service, service instance, or component.
nextToken (string) --
A token that indicates the location of the next deployment in the array of deployment, after the current requested list of deployment.
Delete the deployment.
See also: AWS API Documentation
Request Syntax
client.delete_deployment(
id='string'
)
string
[REQUIRED]
The ID of the deployment to delete.
dict
Response Syntax
{
'deployment': {
'arn': 'string',
'completedAt': datetime(2015, 1, 1),
'componentName': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'id': 'string',
'initialState': {
'component': {
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string',
'templateFile': 'string'
},
'environment': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'serviceInstance': {
'lastSuccessfulComponentDeploymentIds': [
'string',
],
'lastSuccessfulEnvironmentDeploymentId': 'string',
'lastSuccessfulServicePipelineDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'servicePipeline': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
},
'lastAttemptedDeploymentId': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'targetArn': 'string',
'targetResourceCreatedAt': datetime(2015, 1, 1),
'targetResourceType': 'ENVIRONMENT'|'SERVICE_PIPELINE'|'SERVICE_INSTANCE'|'COMPONENT',
'targetState': {
'component': {
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string',
'templateFile': 'string'
},
'environment': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'serviceInstance': {
'lastSuccessfulComponentDeploymentIds': [
'string',
],
'lastSuccessfulEnvironmentDeploymentId': 'string',
'lastSuccessfulServicePipelineDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'servicePipeline': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
}
}
Response Structure
(dict) --
deployment (dict) --
The detailed data of the deployment being deleted.
arn (string) --
The Amazon Resource Name (ARN) of the deployment.
completedAt (datetime) --
The date and time the deployment was completed.
componentName (string) --
The name of the component associated with this deployment.
createdAt (datetime) --
The date and time the deployment was created.
deploymentStatus (string) --
The status of the deployment.
deploymentStatusMessage (string) --
The deployment status message.
environmentName (string) --
The name of the environment associated with this deployment.
id (string) --
The ID of the deployment.
initialState (dict) --
The initial state of the target resource at the time of the deployment.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: component, environment, serviceInstance, servicePipeline. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
component (dict) --
The state of the component associated with the deployment.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
templateFile (string) --
The template file used.
environment (dict) --
The state of the environment associated with the deployment.
spec (string) --
The environment spec that was used to create the environment.
templateMajorVersion (string) --
The major version of the environment template that was used to create the environment.
templateMinorVersion (string) --
The minor version of the environment template that was used to create the environment.
templateName (string) --
The name of the environment template that was used to create the environment.
serviceInstance (dict) --
The state of the service instance associated with the deployment.
lastSuccessfulComponentDeploymentIds (list) --
The IDs for the last successful components deployed for this service instance.
(string) --
lastSuccessfulEnvironmentDeploymentId (string) --
The ID for the last successful environment deployed for this service instance.
lastSuccessfulServicePipelineDeploymentId (string) --
The ID for the last successful service pipeline deployed for this service instance.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service instance.
servicePipeline (dict) --
The state of the service pipeline associated with the deployment.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment.
lastModifiedAt (datetime) --
The date and time the deployment was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment.
serviceInstanceName (string) --
The name of the deployment's service instance.
serviceName (string) --
The name of the service in this deployment.
targetArn (string) --
The Amazon Resource Name (ARN) of the target of the deployment.
targetResourceCreatedAt (datetime) --
The date and time the depoyment target was created.
targetResourceType (string) --
The resource type of the deployment target. It can be an environment, service, service instance, or component.
targetState (dict) --
The target state of the target resource at the time of the deployment.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: component, environment, serviceInstance, servicePipeline. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
component (dict) --
The state of the component associated with the deployment.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
templateFile (string) --
The template file used.
environment (dict) --
The state of the environment associated with the deployment.
spec (string) --
The environment spec that was used to create the environment.
templateMajorVersion (string) --
The major version of the environment template that was used to create the environment.
templateMinorVersion (string) --
The minor version of the environment template that was used to create the environment.
templateName (string) --
The name of the environment template that was used to create the environment.
serviceInstance (dict) --
The state of the service instance associated with the deployment.
lastSuccessfulComponentDeploymentIds (list) --
The IDs for the last successful components deployed for this service instance.
(string) --
lastSuccessfulEnvironmentDeploymentId (string) --
The ID for the last successful environment deployed for this service instance.
lastSuccessfulServicePipelineDeploymentId (string) --
The ID for the last successful service pipeline deployed for this service instance.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service instance.
servicePipeline (dict) --
The state of the service pipeline associated with the deployment.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
Get detailed data for a deployment.
See also: AWS API Documentation
Request Syntax
client.get_deployment(
componentName='string',
environmentName='string',
id='string',
serviceInstanceName='string',
serviceName='string'
)
string
The name of a component that you want to get the detailed data for.
string
The name of a environment that you want to get the detailed data for.
string
[REQUIRED]
The ID of the deployment that you want to get the detailed data for.
string
The name of the service instance associated with the given deployment ID. serviceName must be specified to identify the service instance.
string
The name of the service associated with the given deployment ID.
dict
Response Syntax
{
'deployment': {
'arn': 'string',
'completedAt': datetime(2015, 1, 1),
'componentName': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'id': 'string',
'initialState': {
'component': {
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string',
'templateFile': 'string'
},
'environment': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'serviceInstance': {
'lastSuccessfulComponentDeploymentIds': [
'string',
],
'lastSuccessfulEnvironmentDeploymentId': 'string',
'lastSuccessfulServicePipelineDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'servicePipeline': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
},
'lastAttemptedDeploymentId': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'targetArn': 'string',
'targetResourceCreatedAt': datetime(2015, 1, 1),
'targetResourceType': 'ENVIRONMENT'|'SERVICE_PIPELINE'|'SERVICE_INSTANCE'|'COMPONENT',
'targetState': {
'component': {
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string',
'templateFile': 'string'
},
'environment': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'serviceInstance': {
'lastSuccessfulComponentDeploymentIds': [
'string',
],
'lastSuccessfulEnvironmentDeploymentId': 'string',
'lastSuccessfulServicePipelineDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'servicePipeline': {
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
}
}
Response Structure
(dict) --
deployment (dict) --
The detailed data of the requested deployment.
arn (string) --
The Amazon Resource Name (ARN) of the deployment.
completedAt (datetime) --
The date and time the deployment was completed.
componentName (string) --
The name of the component associated with this deployment.
createdAt (datetime) --
The date and time the deployment was created.
deploymentStatus (string) --
The status of the deployment.
deploymentStatusMessage (string) --
The deployment status message.
environmentName (string) --
The name of the environment associated with this deployment.
id (string) --
The ID of the deployment.
initialState (dict) --
The initial state of the target resource at the time of the deployment.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: component, environment, serviceInstance, servicePipeline. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
component (dict) --
The state of the component associated with the deployment.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
templateFile (string) --
The template file used.
environment (dict) --
The state of the environment associated with the deployment.
spec (string) --
The environment spec that was used to create the environment.
templateMajorVersion (string) --
The major version of the environment template that was used to create the environment.
templateMinorVersion (string) --
The minor version of the environment template that was used to create the environment.
templateName (string) --
The name of the environment template that was used to create the environment.
serviceInstance (dict) --
The state of the service instance associated with the deployment.
lastSuccessfulComponentDeploymentIds (list) --
The IDs for the last successful components deployed for this service instance.
(string) --
lastSuccessfulEnvironmentDeploymentId (string) --
The ID for the last successful environment deployed for this service instance.
lastSuccessfulServicePipelineDeploymentId (string) --
The ID for the last successful service pipeline deployed for this service instance.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service instance.
servicePipeline (dict) --
The state of the service pipeline associated with the deployment.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment.
lastModifiedAt (datetime) --
The date and time the deployment was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment.
serviceInstanceName (string) --
The name of the deployment's service instance.
serviceName (string) --
The name of the service in this deployment.
targetArn (string) --
The Amazon Resource Name (ARN) of the target of the deployment.
targetResourceCreatedAt (datetime) --
The date and time the depoyment target was created.
targetResourceType (string) --
The resource type of the deployment target. It can be an environment, service, service instance, or component.
targetState (dict) --
The target state of the target resource at the time of the deployment.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: component, environment, serviceInstance, servicePipeline. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
component (dict) --
The state of the component associated with the deployment.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
templateFile (string) --
The template file used.
environment (dict) --
The state of the environment associated with the deployment.
spec (string) --
The environment spec that was used to create the environment.
templateMajorVersion (string) --
The major version of the environment template that was used to create the environment.
templateMinorVersion (string) --
The minor version of the environment template that was used to create the environment.
templateName (string) --
The name of the environment template that was used to create the environment.
serviceInstance (dict) --
The state of the service instance associated with the deployment.
lastSuccessfulComponentDeploymentIds (list) --
The IDs for the last successful components deployed for this service instance.
(string) --
lastSuccessfulEnvironmentDeploymentId (string) --
The ID for the last successful environment deployed for this service instance.
lastSuccessfulServicePipelineDeploymentId (string) --
The ID for the last successful service pipeline deployed for this service instance.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service instance.
servicePipeline (dict) --
The state of the service pipeline associated with the deployment.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
{'component': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.cancel_component_deployment(
componentName='string'
)
string
[REQUIRED]
The name of the component with the deployment to cancel.
dict
Response Syntax
{
'component': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
(dict) --
component (dict) --
The detailed data of the component with the deployment that is being canceled.
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
description (string) --
A description of the component.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this component.
lastClientRequestToken (string) --
The last token the client requested.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this component.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
{'environment': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS . For more information, see Update an environment in the 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 UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.
See also: AWS API Documentation
Request Syntax
client.cancel_environment_deployment(
environmentName='string'
)
string
[REQUIRED]
The name of the environment with the deployment to cancel.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentAccountConnectionId': 'string',
'environmentAccountId': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'protonServiceRoleArn': 'string',
'provisioning': 'CUSTOMER_MANAGED',
'provisioningRepository': {
'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
environment (dict) --
The environment summary data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
createdAt (datetime) --
The time when the environment was created.
deploymentStatus (string) --
The environment deployment status.
deploymentStatusMessage (string) --
An environment deployment status message.
description (string) --
The description of the environment.
environmentAccountConnectionId (string) --
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
environmentAccountId (string) --
The ID of the environment account that the environment infrastructure resources are provisioned in.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this environment.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the environment was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this environment.
name (string) --
The name of the environment.
protonServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
provisioning (string) --
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
provisioningRepository (dict) --
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The Amazon Resource Name (ARN) of the environment template.
{'serviceInstance': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS . For more information, see Update a service instance in the 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 action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.
See also: AWS API Documentation
Request Syntax
client.cancel_service_instance_deployment(
serviceInstanceName='string',
serviceName='string'
)
string
[REQUIRED]
The name of the service instance with the deployment to cancel.
string
[REQUIRED]
The name of the service with the service instance deployment to cancel.
dict
Response Syntax
{
'serviceInstance': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceName': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
serviceInstance (dict) --
The service instance summary data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the service instance.
createdAt (datetime) --
The time when the service instance was created.
deploymentStatus (string) --
The service instance deployment status.
deploymentStatusMessage (string) --
The message associated with the service instance deployment status.
environmentName (string) --
The name of the environment that the service instance was deployed into.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service instance.
lastClientRequestToken (string) --
The last client request token received.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service instance was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service instance was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service instance.
name (string) --
The name of the service instance.
serviceName (string) --
The name of the service that the service instance belongs to.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service instance.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service instance.
templateName (string) --
The name of the service template that was used to create the service instance.
{'pipeline': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS . For more information, see Update a service pipeline in the 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 action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.
See also: AWS API Documentation
Request Syntax
client.cancel_service_pipeline_deployment(
serviceName='string'
)
string
[REQUIRED]
The name of the service with the service pipeline deployment to cancel.
dict
Response Syntax
{
'pipeline': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
pipeline (dict) --
The service pipeline detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the service pipeline.
createdAt (datetime) --
The time when the service pipeline was created.
deploymentStatus (string) --
The deployment status of the service pipeline.
deploymentStatusMessage (string) --
A service pipeline deployment status message.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service pipeline.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service pipeline was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service pipeline was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service pipeline.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
{'component': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Create an Proton component. A component is an infrastructure extension for a service instance.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.create_component(
clientToken='string',
description='string',
environmentName='string',
manifest='string',
name='string',
serviceInstanceName='string',
serviceName='string',
serviceSpec='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
templateFile='string'
)
string
The client token for the created component.
This field is autopopulated if not provided.
string
An optional customer-provided description of the component.
string
The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName .
string
[REQUIRED]
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
string
[REQUIRED]
The customer-provided name of the component.
string
The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
string
The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
string
The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
list
An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
string
[REQUIRED]
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Note
Components support a single IaC file, even if you use Terraform as your template language.
dict
Response Syntax
{
'component': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
(dict) --
component (dict) --
The detailed data of the created component.
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
description (string) --
A description of the component.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this component.
lastClientRequestToken (string) --
The last token the client requested.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this component.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
{'environment': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Deploy a new environment. An 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:
Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
Self-managed provisioning: 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 Environments and Provisioning methods in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.create_environment(
codebuildRoleArn='string',
componentRoleArn='string',
description='string',
environmentAccountConnectionId='string',
name='string',
protonServiceRoleArn='string',
provisioningRepository={
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
spec='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
templateMajorVersion='string',
templateMinorVersion='string',
templateName='string'
)
string
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.
string
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
You must specify componentRoleArn to allow directly defined components to be associated with this environment.
For more information about components, see Proton components in the Proton User Guide .
string
A description of the environment that's being created and deployed.
string
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide .
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
string
[REQUIRED]
The name of the environment.
string
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
dict
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
branch (string) -- [REQUIRED]
The repository branch.
name (string) -- [REQUIRED]
The repository name.
provider (string) -- [REQUIRED]
The repository provider.
string
[REQUIRED]
A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide .
list
An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
string
[REQUIRED]
The major version of the environment template.
string
The minor version of the environment template.
string
[REQUIRED]
The name of the environment template. For more information, see Environment Templates in the Proton User Guide .
dict
Response Syntax
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentAccountConnectionId': 'string',
'environmentAccountId': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'protonServiceRoleArn': 'string',
'provisioning': 'CUSTOMER_MANAGED',
'provisioningRepository': {
'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
environment (dict) --
The environment detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
createdAt (datetime) --
The time when the environment was created.
deploymentStatus (string) --
The environment deployment status.
deploymentStatusMessage (string) --
An environment deployment status message.
description (string) --
The description of the environment.
environmentAccountConnectionId (string) --
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
environmentAccountId (string) --
The ID of the environment account that the environment infrastructure resources are provisioned in.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this environment.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the environment was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this environment.
name (string) --
The name of the environment.
protonServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
provisioning (string) --
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
provisioningRepository (dict) --
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The Amazon Resource Name (ARN) of the environment template.
{'service': {'pipeline': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}}
Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.create_service(
branchName='string',
description='string',
name='string',
repositoryConnectionArn='string',
repositoryId='string',
spec='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
templateMajorVersion='string',
templateMinorVersion='string',
templateName='string'
)
string
The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.
string
A description of the Proton service.
string
[REQUIRED]
The service name.
string
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide . Don't include this parameter if your service template doesn't include a service pipeline.
string
The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
string
[REQUIRED]
A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide .
list
An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
string
[REQUIRED]
The major version of the service template that was used to create the service.
string
The minor version of the service template that was used to create the service.
string
[REQUIRED]
The name of the service template that's used to create the service.
dict
Response Syntax
{
'service': {
'arn': 'string',
'branchName': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'pipeline': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'repositoryConnectionArn': 'string',
'repositoryId': 'string',
'spec': 'string',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
'statusMessage': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
service (dict) --
The service detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the service.
branchName (string) --
The name of the code repository branch that holds the code that's deployed in Proton.
createdAt (datetime) --
The time when the service was created.
description (string) --
A description of the service.
lastModifiedAt (datetime) --
The time when the service was last modified.
name (string) --
The name of the service.
pipeline (dict) --
The service pipeline detail data.
arn (string) --
The Amazon Resource Name (ARN) of the service pipeline.
createdAt (datetime) --
The time when the service pipeline was created.
deploymentStatus (string) --
The deployment status of the service pipeline.
deploymentStatusMessage (string) --
A service pipeline deployment status message.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service pipeline.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service pipeline was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service pipeline was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service pipeline.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
repositoryConnectionArn (string) --
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide .
repositoryId (string) --
The ID of the source code repository.
spec (string) --
The formatted specification that defines the service.
status (string) --
The status of the service.
statusMessage (string) --
A service status message.
templateName (string) --
The name of the service template.
{'serviceInstance': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Create a service instance.
See also: AWS API Documentation
Request Syntax
client.create_service_instance(
clientToken='string',
name='string',
serviceName='string',
spec='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
templateMajorVersion='string',
templateMinorVersion='string'
)
string
The client token of the service instance to create.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service instance to create.
string
[REQUIRED]
The name of the service the service instance is added to.
string
[REQUIRED]
The spec for the service instance you want to create.
list
An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
string
To create a new major and minor version of the service template, exclude major Version .
string
To create a new minor version of the service template, include a major Version .
dict
Response Syntax
{
'serviceInstance': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceName': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
serviceInstance (dict) --
The detailed data of the service instance being created.
arn (string) --
The Amazon Resource Name (ARN) of the service instance.
createdAt (datetime) --
The time when the service instance was created.
deploymentStatus (string) --
The service instance deployment status.
deploymentStatusMessage (string) --
The message associated with the service instance deployment status.
environmentName (string) --
The name of the environment that the service instance was deployed into.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service instance.
lastClientRequestToken (string) --
The last client request token received.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service instance was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service instance was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service instance.
name (string) --
The name of the service instance.
serviceName (string) --
The name of the service that the service instance belongs to.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service instance.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service instance.
templateName (string) --
The name of the service template that was used to create the service instance.
{'component': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.delete_component(
name='string'
)
string
[REQUIRED]
The name of the component to delete.
dict
Response Syntax
{
'component': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
(dict) --
component (dict) --
The detailed data of the component being deleted.
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
description (string) --
A description of the component.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this component.
lastClientRequestToken (string) --
The last token the client requested.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this component.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
{'environment': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Delete an environment.
See also: AWS API Documentation
Request Syntax
client.delete_environment(
name='string'
)
string
[REQUIRED]
The name of the environment to delete.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentAccountConnectionId': 'string',
'environmentAccountId': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'protonServiceRoleArn': 'string',
'provisioning': 'CUSTOMER_MANAGED',
'provisioningRepository': {
'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
environment (dict) --
The detailed data of the environment being deleted.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
createdAt (datetime) --
The time when the environment was created.
deploymentStatus (string) --
The environment deployment status.
deploymentStatusMessage (string) --
An environment deployment status message.
description (string) --
The description of the environment.
environmentAccountConnectionId (string) --
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
environmentAccountId (string) --
The ID of the environment account that the environment infrastructure resources are provisioned in.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this environment.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the environment was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this environment.
name (string) --
The name of the environment.
protonServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
provisioning (string) --
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
provisioningRepository (dict) --
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The Amazon Resource Name (ARN) of the environment template.
{'service': {'pipeline': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}}
Delete a service, with its instances and pipeline.
Note
You can't delete a service if it has any service instances that have components attached to them.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.delete_service(
name='string'
)
string
[REQUIRED]
The name of the service to delete.
dict
Response Syntax
{
'service': {
'arn': 'string',
'branchName': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'pipeline': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'repositoryConnectionArn': 'string',
'repositoryId': 'string',
'spec': 'string',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
'statusMessage': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
service (dict) --
The detailed data of the service being deleted.
arn (string) --
The Amazon Resource Name (ARN) of the service.
branchName (string) --
The name of the code repository branch that holds the code that's deployed in Proton.
createdAt (datetime) --
The time when the service was created.
description (string) --
A description of the service.
lastModifiedAt (datetime) --
The time when the service was last modified.
name (string) --
The name of the service.
pipeline (dict) --
The service pipeline detail data.
arn (string) --
The Amazon Resource Name (ARN) of the service pipeline.
createdAt (datetime) --
The time when the service pipeline was created.
deploymentStatus (string) --
The deployment status of the service pipeline.
deploymentStatusMessage (string) --
A service pipeline deployment status message.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service pipeline.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service pipeline was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service pipeline was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service pipeline.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
repositoryConnectionArn (string) --
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide .
repositoryId (string) --
The ID of the source code repository.
spec (string) --
The formatted specification that defines the service.
status (string) --
The status of the service.
statusMessage (string) --
A service status message.
templateName (string) --
The name of the service template.
{'component': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Get detailed data for a component.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.get_component(
name='string'
)
string
[REQUIRED]
The name of the component that you want to get the detailed data for.
dict
Response Syntax
{
'component': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
(dict) --
component (dict) --
The detailed data of the requested component.
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
description (string) --
A description of the component.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this component.
lastClientRequestToken (string) --
The last token the client requested.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this component.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
{'environment': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Get detailed data for an environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
name='string'
)
string
[REQUIRED]
The name of the environment that you want to get the detailed data for.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentAccountConnectionId': 'string',
'environmentAccountId': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'protonServiceRoleArn': 'string',
'provisioning': 'CUSTOMER_MANAGED',
'provisioningRepository': {
'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
environment (dict) --
The detailed data of the requested environment.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
createdAt (datetime) --
The time when the environment was created.
deploymentStatus (string) --
The environment deployment status.
deploymentStatusMessage (string) --
An environment deployment status message.
description (string) --
The description of the environment.
environmentAccountConnectionId (string) --
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
environmentAccountId (string) --
The ID of the environment account that the environment infrastructure resources are provisioned in.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this environment.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the environment was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this environment.
name (string) --
The name of the environment.
protonServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
provisioning (string) --
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
provisioningRepository (dict) --
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The Amazon Resource Name (ARN) of the environment template.
{'service': {'pipeline': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}}
Get detailed data for a service.
See also: AWS API Documentation
Request Syntax
client.get_service(
name='string'
)
string
[REQUIRED]
The name of the service that you want to get the detailed data for.
dict
Response Syntax
{
'service': {
'arn': 'string',
'branchName': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'pipeline': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'repositoryConnectionArn': 'string',
'repositoryId': 'string',
'spec': 'string',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
'statusMessage': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
service (dict) --
The detailed data of the requested service.
arn (string) --
The Amazon Resource Name (ARN) of the service.
branchName (string) --
The name of the code repository branch that holds the code that's deployed in Proton.
createdAt (datetime) --
The time when the service was created.
description (string) --
A description of the service.
lastModifiedAt (datetime) --
The time when the service was last modified.
name (string) --
The name of the service.
pipeline (dict) --
The service pipeline detail data.
arn (string) --
The Amazon Resource Name (ARN) of the service pipeline.
createdAt (datetime) --
The time when the service pipeline was created.
deploymentStatus (string) --
The deployment status of the service pipeline.
deploymentStatusMessage (string) --
A service pipeline deployment status message.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service pipeline.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service pipeline was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service pipeline was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service pipeline.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
repositoryConnectionArn (string) --
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide .
repositoryId (string) --
The ID of the source code repository.
spec (string) --
The formatted specification that defines the service.
status (string) --
The status of the service.
statusMessage (string) --
A service status message.
templateName (string) --
The name of the service template.
{'serviceInstance': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
See also: AWS API Documentation
Request Syntax
client.get_service_instance(
name='string',
serviceName='string'
)
string
[REQUIRED]
The name of a service instance that you want to get the detailed data for.
string
[REQUIRED]
The name of the service that you want the service instance input for.
dict
Response Syntax
{
'serviceInstance': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceName': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
serviceInstance (dict) --
The detailed data of the requested service instance.
arn (string) --
The Amazon Resource Name (ARN) of the service instance.
createdAt (datetime) --
The time when the service instance was created.
deploymentStatus (string) --
The service instance deployment status.
deploymentStatusMessage (string) --
The message associated with the service instance deployment status.
environmentName (string) --
The name of the environment that the service instance was deployed into.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service instance.
lastClientRequestToken (string) --
The last client request token received.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service instance was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service instance was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service instance.
name (string) --
The name of the service instance.
serviceName (string) --
The name of the service that the service instance belongs to.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service instance.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service instance.
templateName (string) --
The name of the service template that was used to create the service instance.
{'deploymentId': 'string'}
Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.list_component_outputs(
componentName='string',
deploymentId='string',
nextToken='string'
)
string
[REQUIRED]
The name of the component whose outputs you want.
string
The ID of the deployment whose outputs you want.
string
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
outputs (list) --
An array of component Infrastructure as Code (IaC) outputs.
(dict) --
An infrastructure as code defined resource output.
key (string) --
The output key.
valueString (string) --
The output value.
{'components': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
List components with summary data. You can filter the result list by environment, service, or a single service instance.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.list_components(
environmentName='string',
maxResults=123,
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
string
The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
integer
The maximum number of components to list.
string
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
string
The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
string
The name of a service for result list filtering. Proton returns components attached to service instances of the service.
dict
Response Syntax
{
'components': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
components (list) --
An array of components with summary data.
(dict) --
Summary data of an Proton component resource.
For more information about components, see Proton components in the Proton User Guide .
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this component.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this component.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
nextToken (string) --
A token that indicates the location of the next component in the array of components, after the current requested list of components.
{'deploymentId': 'string'}
List the infrastructure as code outputs for your environment.
See also: AWS API Documentation
Request Syntax
client.list_environment_outputs(
deploymentId='string',
environmentName='string',
nextToken='string'
)
string
The ID of the deployment whose outputs you want.
string
[REQUIRED]
The environment name.
string
A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.
outputs (list) --
An array of environment outputs with detail data.
(dict) --
An infrastructure as code defined resource output.
key (string) --
The output key.
valueString (string) --
The output value.
{'environments': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
List environments with detail data summaries.
See also: AWS API Documentation
Request Syntax
client.list_environments(
environmentTemplates=[
{
'majorVersion': 'string',
'templateName': 'string'
},
],
maxResults=123,
nextToken='string'
)
list
An array of the versions of the environment template.
(dict) --
A search filter for environment templates.
majorVersion (string) -- [REQUIRED]
Include majorVersion to filter search for a major version.
templateName (string) -- [REQUIRED]
Include templateName to filter search for a template name.
integer
The maximum number of environments to list.
string
A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.
dict
Response Syntax
{
'environments': [
{
'arn': 'string',
'componentRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentAccountConnectionId': 'string',
'environmentAccountId': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'protonServiceRoleArn': 'string',
'provisioning': 'CUSTOMER_MANAGED',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
environments (list) --
An array of environment detail data summaries.
(dict) --
Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
createdAt (datetime) --
The time when the environment was created.
deploymentStatus (string) --
The environment deployment status.
deploymentStatusMessage (string) --
An environment deployment status message.
description (string) --
The description of the environment.
environmentAccountConnectionId (string) --
The ID of the environment account connection that the environment is associated with.
environmentAccountId (string) --
The ID of the environment account that the environment infrastructure resources are provisioned in.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this environment.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the environment was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this environment.
name (string) --
The name of the environment.
protonServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
provisioning (string) --
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The name of the environment template.
nextToken (string) --
A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.
{'deploymentId': 'string'}
Get a list service of instance Infrastructure as Code (IaC) outputs.
See also: AWS API Documentation
Request Syntax
client.list_service_instance_outputs(
deploymentId='string',
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
string
The ID of the deployment whose outputs you want.
string
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
string
[REQUIRED]
The name of the service instance whose outputs you want.
string
[REQUIRED]
The name of the service that serviceInstanceName is associated to.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
outputs (list) --
An array of service instance Infrastructure as Code (IaC) outputs.
(dict) --
An infrastructure as code defined resource output.
key (string) --
The output key.
valueString (string) --
The output value.
{'serviceInstances': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_service_instances(
filters=[
{
'key': 'name'|'deploymentStatus'|'templateName'|'serviceName'|'deployedTemplateVersionStatus'|'environmentName'|'lastDeploymentAttemptedAtBefore'|'lastDeploymentAttemptedAtAfter'|'createdAtBefore'|'createdAtAfter',
'value': 'string'
},
],
maxResults=123,
nextToken='string',
serviceName='string',
sortBy='name'|'deploymentStatus'|'templateName'|'serviceName'|'environmentName'|'lastDeploymentAttemptedAt'|'createdAt',
sortOrder='ASCENDING'|'DESCENDING'
)
list
An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.
(dict) --
A filtering criterion to scope down the result list of the ListServiceInstances action.
key (string) --
The name of a filtering criterion.
value (string) --
A value to filter by.
With the date/time keys ( *At{Before,After} ), the value is a valid RFC 3339 string with no UTC offset and with an optional fractional precision (for example, 1985-04-12T23:20:50.52Z ).
integer
The maximum number of service instances to list.
string
A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
string
The name of the service that the service instance belongs to.
string
The field that the result list is sorted by.
When you choose to sort by serviceName , service instances within each service are sorted by service instance name.
Default: serviceName
string
Result list sort order.
Default: ASCENDING
dict
Response Syntax
{
'nextToken': 'string',
'serviceInstances': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceName': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.
serviceInstances (list) --
An array of service instances with summary data.
(dict) --
Summary data of an Proton service instance resource.
arn (string) --
The Amazon Resource Name (ARN) of the service instance.
createdAt (datetime) --
The time when the service instance was created.
deploymentStatus (string) --
The service instance deployment status.
deploymentStatusMessage (string) --
A service instance deployment status message.
environmentName (string) --
The name of the environment that the service instance was deployed into.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service instance.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service instance.
name (string) --
The name of the service instance.
serviceName (string) --
The name of the service that the service instance belongs to.
templateMajorVersion (string) --
The service instance template major version.
templateMinorVersion (string) --
The service instance template minor version.
templateName (string) --
The name of the service template.
{'deploymentId': 'string'}
Get a list of service pipeline Infrastructure as Code (IaC) outputs.
See also: AWS API Documentation
Request Syntax
client.list_service_pipeline_outputs(
deploymentId='string',
nextToken='string',
serviceName='string'
)
string
The ID of the deployment you want the outputs for.
string
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
string
[REQUIRED]
The name of the service whose pipeline's outputs you want.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
outputs (list) --
An array of service pipeline Infrastructure as Code (IaC) outputs.
(dict) --
An infrastructure as code defined resource output.
key (string) --
The output key.
valueString (string) --
The output value.
{'component': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Update a component.
There are a few modes for updating a component. The deploymentType field defines the mode.
Note
You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS .
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.update_component(
clientToken='string',
deploymentType='NONE'|'CURRENT_VERSION',
description='string',
name='string',
serviceInstanceName='string',
serviceName='string',
serviceSpec='string',
templateFile='string'
)
string
The client token for the updated component.
This field is autopopulated if not provided.
string
[REQUIRED]
The deployment type. It defines the mode for updating a component, as follows:
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.
CURRENT_VERSION
In this mode, the component is deployed and updated with the new serviceSpec , templateSource , and/or type that you provide. Only requested parameters are updated.
string
An optional customer-provided description of the component.
string
[REQUIRED]
The name of the component to update.
string
The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.
string
The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.
string
The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.
string
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Note
Components support a single IaC file, even if you use Terraform as your template language.
dict
Response Syntax
{
'component': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
(dict) --
component (dict) --
The detailed data of the updated component.
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
description (string) --
A description of the component.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this component.
lastClientRequestToken (string) --
The last token the client requested.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this component.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
{'environment': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Update an environment.
If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter. You can't update or connect the environment to an environment account connection if it isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.
If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.
If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.
For more information, see Environments and Provisioning methods in the Proton User Guide .
There are four modes for updating an environment. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.
See also: AWS API Documentation
Request Syntax
client.update_environment(
codebuildRoleArn='string',
componentRoleArn='string',
deploymentType='NONE'|'CURRENT_VERSION'|'MINOR_VERSION'|'MAJOR_VERSION',
description='string',
environmentAccountConnectionId='string',
name='string',
protonServiceRoleArn='string',
provisioningRepository={
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
spec='string',
templateMajorVersion='string',
templateMinorVersion='string'
)
string
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
string
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
string
[REQUIRED]
There are four modes for updating an environment. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type .
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
string
A description of the environment update.
string
The ID of the environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
string
[REQUIRED]
The name of the environment to update.
string
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
dict
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
branch (string) -- [REQUIRED]
The repository branch.
name (string) -- [REQUIRED]
The repository name.
provider (string) -- [REQUIRED]
The repository provider.
string
The formatted specification that defines the update.
string
The major version of the environment to update.
string
The minor version of the environment to update.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'description': 'string',
'environmentAccountConnectionId': 'string',
'environmentAccountId': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'protonServiceRoleArn': 'string',
'provisioning': 'CUSTOMER_MANAGED',
'provisioningRepository': {
'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
environment (dict) --
The environment detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
createdAt (datetime) --
The time when the environment was created.
deploymentStatus (string) --
The environment deployment status.
deploymentStatusMessage (string) --
An environment deployment status message.
description (string) --
The description of the environment.
environmentAccountConnectionId (string) --
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
environmentAccountId (string) --
The ID of the environment account that the environment infrastructure resources are provisioned in.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this environment.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the environment was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this environment.
name (string) --
The name of the environment.
protonServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
provisioning (string) --
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
provisioningRepository (dict) --
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The Amazon Resource Name (ARN) of the environment template.
{'service': {'pipeline': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}}
Edit a service description or use a spec to add and delete service instances.
Note
Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.
Use the description parameter to modify the description.
Edit the spec parameter to add or delete instances.
Note
You can't delete a service instance (remove it from the spec) if it has an attached component.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.update_service(
description='string',
name='string',
spec='string'
)
string
The edited service description.
string
[REQUIRED]
The name of the service to edit.
string
Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the Proton User Guide .
dict
Response Syntax
{
'service': {
'arn': 'string',
'branchName': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'pipeline': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
},
'repositoryConnectionArn': 'string',
'repositoryId': 'string',
'spec': 'string',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
'statusMessage': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
service (dict) --
The service detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the service.
branchName (string) --
The name of the code repository branch that holds the code that's deployed in Proton.
createdAt (datetime) --
The time when the service was created.
description (string) --
A description of the service.
lastModifiedAt (datetime) --
The time when the service was last modified.
name (string) --
The name of the service.
pipeline (dict) --
The service pipeline detail data.
arn (string) --
The Amazon Resource Name (ARN) of the service pipeline.
createdAt (datetime) --
The time when the service pipeline was created.
deploymentStatus (string) --
The deployment status of the service pipeline.
deploymentStatusMessage (string) --
A service pipeline deployment status message.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service pipeline.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service pipeline was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service pipeline was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service pipeline.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.
repositoryConnectionArn (string) --
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide .
repositoryId (string) --
The ID of the source code repository.
spec (string) --
The formatted specification that defines the service.
status (string) --
The status of the service.
statusMessage (string) --
A service status message.
templateName (string) --
The name of the service template.
{'serviceInstance': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Update a service instance.
There are a few modes for updating a service instance. The deploymentType field defines the mode.
Note
You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS .
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
client.update_service_instance(
clientToken='string',
deploymentType='NONE'|'CURRENT_VERSION'|'MINOR_VERSION'|'MAJOR_VERSION',
name='string',
serviceName='string',
spec='string',
templateMajorVersion='string',
templateMinorVersion='string'
)
string
The client token of the service instance to update.
This field is autopopulated if not provided.
string
[REQUIRED]
The deployment type. It defines the mode for updating a service instance, as follows:
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.
MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
string
[REQUIRED]
The name of the service instance to update.
string
[REQUIRED]
The name of the service that the service instance belongs to.
string
The formatted specification that defines the service instance update.
string
The major version of the service template to update.
string
The minor version of the service template to update.
dict
Response Syntax
{
'serviceInstance': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'environmentName': 'string',
'lastAttemptedDeploymentId': 'string',
'lastClientRequestToken': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'name': 'string',
'serviceName': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
serviceInstance (dict) --
The service instance summary data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the service instance.
createdAt (datetime) --
The time when the service instance was created.
deploymentStatus (string) --
The service instance deployment status.
deploymentStatusMessage (string) --
The message associated with the service instance deployment status.
environmentName (string) --
The name of the environment that the service instance was deployed into.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service instance.
lastClientRequestToken (string) --
The last client request token received.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service instance was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service instance was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service instance.
name (string) --
The name of the service instance.
serviceName (string) --
The name of the service that the service instance belongs to.
spec (string) --
The service spec that was used to create the service instance.
templateMajorVersion (string) --
The major version of the service template that was used to create the service instance.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service instance.
templateName (string) --
The name of the service template that was used to create the service instance.
{'pipeline': {'lastAttemptedDeploymentId': 'string',
'lastSucceededDeploymentId': 'string'}}
Update the service pipeline.
There are four modes for updating a service pipeline. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type .
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that's higher than the major version in use and a minor version.
See also: AWS API Documentation
Request Syntax
client.update_service_pipeline(
deploymentType='NONE'|'CURRENT_VERSION'|'MINOR_VERSION'|'MAJOR_VERSION',
serviceName='string',
spec='string',
templateMajorVersion='string',
templateMinorVersion='string'
)
string
[REQUIRED]
The deployment type.
There are four modes for updating a service pipeline. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type .
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
string
[REQUIRED]
The name of the service to that the pipeline is associated with.
string
[REQUIRED]
The spec for the service pipeline to update.
string
The major version of the service template that was used to create the service that the pipeline is associated with.
string
The minor version of the service template that was used to create the service that the pipeline is associated with.
dict
Response Syntax
{
'pipeline': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
'deploymentStatusMessage': 'string',
'lastAttemptedDeploymentId': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastSucceededDeploymentId': 'string',
'spec': 'string',
'templateMajorVersion': 'string',
'templateMinorVersion': 'string',
'templateName': 'string'
}
}
Response Structure
(dict) --
pipeline (dict) --
The pipeline details that are returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the service pipeline.
createdAt (datetime) --
The time when the service pipeline was created.
deploymentStatus (string) --
The deployment status of the service pipeline.
deploymentStatusMessage (string) --
A service pipeline deployment status message.
lastAttemptedDeploymentId (string) --
The ID of the last attempted deployment of this service pipeline.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the service pipeline was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the service pipeline was last deployed successfully.
lastSucceededDeploymentId (string) --
The ID of the last successful deployment of this service pipeline.
spec (string) --
The service spec that was used to create the service pipeline.
templateMajorVersion (string) --
The major version of the service template that was used to create the service pipeline.
templateMinorVersion (string) --
The minor version of the service template that was used to create the service pipeline.
templateName (string) --
The name of the service template that was used to create the service pipeline.