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 ]

get-service-instance-sync-status

Description

Get the status of the synced service instance.

See also: AWS API Documentation

Synopsis

  get-service-instance-sync-status
--service-instance-name <value>
--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

--service-instance-name (string)

The name of the service instance that you want the sync status input for.

--service-name (string)

The name of the service that the service instance belongs to.

--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.

Output

desiredState -> (structure)

The service instance sync desired state that's returned by Proton

branch -> (string)

The repository branch.

directory -> (string)

The repository directory changed by a commit and push that activated the sync attempt.

repositoryName -> (string)

The repository name.

repositoryProvider -> (string)

The repository provider.

sha -> (string)

The secure hash algorithm (SHA) hash for the revision.

latestSuccessfulSync -> (structure)

The detailed data of the latest successful sync with the service instance.

events -> (list)

An array of events with detail data.

(structure)

Detail data for a resource sync event.

event -> (string)

A resource sync event.

externalId -> (string)

The external ID for the event.

time -> (timestamp)

The time when the event occurred.

type -> (string)

The type of event.

initialRevision -> (structure)

Detail data for the initial repository commit, path and push.

branch -> (string)

The repository branch.

directory -> (string)

The repository directory changed by a commit and push that activated the sync attempt.

repositoryName -> (string)

The repository name.

repositoryProvider -> (string)

The repository provider.

sha -> (string)

The secure hash algorithm (SHA) hash for the revision.

startedAt -> (timestamp)

The time when the sync attempt started.

status -> (string)

The status of the sync attempt.

target -> (string)

The resource that is synced to.

targetRevision -> (structure)

Detail data for the target revision.

branch -> (string)

The repository branch.

directory -> (string)

The repository directory changed by a commit and push that activated the sync attempt.

repositoryName -> (string)

The repository name.

repositoryProvider -> (string)

The repository provider.

sha -> (string)

The secure hash algorithm (SHA) hash for the revision.

latestSync -> (structure)

The detailed data of the latest sync with the service instance.

events -> (list)

An array of events with detail data.

(structure)

Detail data for a resource sync event.

event -> (string)

A resource sync event.

externalId -> (string)

The external ID for the event.

time -> (timestamp)

The time when the event occurred.

type -> (string)

The type of event.

initialRevision -> (structure)

Detail data for the initial repository commit, path and push.

branch -> (string)

The repository branch.

directory -> (string)

The repository directory changed by a commit and push that activated the sync attempt.

repositoryName -> (string)

The repository name.

repositoryProvider -> (string)

The repository provider.

sha -> (string)

The secure hash algorithm (SHA) hash for the revision.

startedAt -> (timestamp)

The time when the sync attempt started.

status -> (string)

The status of the sync attempt.

target -> (string)

The resource that is synced to.

targetRevision -> (structure)

Detail data for the target revision.

branch -> (string)

The repository branch.

directory -> (string)

The repository directory changed by a commit and push that activated the sync attempt.

repositoryName -> (string)

The repository name.

repositoryProvider -> (string)

The repository provider.

sha -> (string)

The secure hash algorithm (SHA) hash for the revision.