Skip to content

Service

Source code in docs_src/capo_proton/types/service.py
class Service(TypedDict, closed=True):
    name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the service.</p>"""
    description: NotRequired["capo_proton.types.description.Description"]
    """<p>A description of the service.</p>"""
    arn: "capo_proton.types.service_arn.ServiceArn"
    """<p>The Amazon Resource Name (ARN) of the service.</p>"""
    template_name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the service template.</p>"""
    created_at: "datetime.datetime"
    """<p>The time when the service was created.</p>"""
    last_modified_at: "datetime.datetime"
    """<p>The time when the service was last modified.</p>"""
    status: "capo_proton.types.service_status.ServiceStatus"
    """<p>The status of the service.</p>"""
    status_message: NotRequired["capo_proton.types.status_message.StatusMessage"]
    """<p>A service status message.</p>"""
    spec: "capo_proton.types.spec_contents.SpecContents"
    """<p>The formatted specification that defines the service.</p>"""
    pipeline: NotRequired["capo_proton.types.service_pipeline.ServicePipeline"]
    """<p>The service pipeline detail data.</p>"""
    repository_connection_arn: NotRequired["capo_proton.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol">Setting up an AWS CodeStar connection</a> in the <i>Proton User Guide</i>.</p>"""
    repository_id: NotRequired["capo_proton.types.repository_id.RepositoryId"]
    """<p>The ID of the source code repository.</p>"""
    branch_name: NotRequired["capo_proton.types.git_branch_name.GitBranchName"]
    """<p>The name of the code repository branch that holds the code that's deployed in Proton.</p>"""

arn instance-attribute

The Amazon Resource Name (ARN) of the service.

branch_name instance-attribute

branch_name: NotRequired[GitBranchName]

The name of the code repository branch that holds the code that's deployed in Proton.

created_at instance-attribute

created_at: datetime

The time when the service was created.

description instance-attribute

description: NotRequired[Description]

A description of the service.

last_modified_at instance-attribute

last_modified_at: datetime

The time when the service was last modified.

name instance-attribute

The name of the service.

pipeline instance-attribute

pipeline: NotRequired[ServicePipeline]

The service pipeline detail data.

repository_connection_arn instance-attribute

repository_connection_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.

repository_id instance-attribute

repository_id: NotRequired[RepositoryId]

The ID of the source code repository.

spec instance-attribute

The formatted specification that defines the service.

status instance-attribute

status: ServiceStatus

The status of the service.

status_message instance-attribute

status_message: NotRequired[StatusMessage]

A service status message.

template_name instance-attribute

template_name: ResourceName

The name of the service template.