AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . proton ]

delete-service

Description

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

Synopsis

  delete-service
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--name (string)

The name of the service to delete.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To delete a service

The following delete-service example deletes a service.

aws proton delete-service \
    --name "simple-svc"

Output:

{
    "service": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc",
        "branchName": "mainline",
        "createdAt": "2020-11-28T22:40:50.512000+00:00",
        "description": "Edit by updating description",
        "lastModifiedAt": "2020-11-29T00:30:39.248000+00:00",
        "name": "simple-svc",
        "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "repositoryId": "myorg/myapp",
        "status": "DELETE_IN_PROGRESS",
        "templateName": "fargate-service"
    }
}

For more information, see Delete a service in the The AWS Proton Administrator Guide.

Output

service -> (structure)

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 -> (timestamp)

The time when the service was created.

description -> (string)

A description of the service.

lastModifiedAt -> (timestamp)

The time when the service was last modified.

name -> (string)

The name of the service.

pipeline -> (structure)

The service pipeline detail data.

arn -> (string)

The Amazon Resource Name (ARN) of the service pipeline.

createdAt -> (timestamp)

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 -> (timestamp)

The time when a deployment of the service pipeline was last attempted.

lastDeploymentSucceededAt -> (timestamp)

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.