Service
Detailed data of an AWS Proton service resource.
Contents
- arn
-
The Amazon Resource Name (ARN) of the service.
Type: String
Required: Yes
- createdAt
-
The time when the service was created.
Type: Timestamp
Required: Yes
- lastModifiedAt
-
The time when the service was last modified.
Type: Timestamp
Required: Yes
- name
-
The name of the service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[0-9A-Za-z]+[0-9A-Za-z_\-]*$Required: Yes
- spec
-
The formatted specification that defines the service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 51200.
Required: Yes
- status
-
The status of the service.
Type: String
Valid Values:
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_FAILEDRequired: Yes
- templateName
-
The name of the service template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[0-9A-Za-z]+[0-9A-Za-z_\-]*$Required: Yes
- branchName
-
The name of the code repository branch that holds the code that's deployed in AWS Proton.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- description
-
A description of the service.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
- pipeline
-
The service pipeline detail data.
Type: ServicePipeline object
Required: No
- repositoryConnectionArn
-
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the AWS Proton User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$Required: No
- repositoryId
-
The ID of the source code repository.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- statusMessage
-
A service status message.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
