AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . evs ]

update-environment-connector

Description

Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata.

Note

You cannot update both the secret and the FQDN in the same request.

See also: AWS API Documentation

Synopsis

  update-environment-connector
[--client-token <value>]
--environment-id <value>
--connector-id <value>
[--appliance-fqdn <value>]
[--secret-identifier <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>]
[--v2-debug]

Options

--client-token (string)

Note

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector update request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

--environment-id (string)

A unique ID for the environment that the connector belongs to.

--connector-id (string)

A unique ID for the connector to update.

--appliance-fqdn (string)

The new fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.

--secret-identifier (string)

The new ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

connector -> (structure)

A description of the updated connector.

environmentId -> (string)

The unique ID of the environment that the connector belongs to.

connectorId -> (string)

The unique ID of the connector.

type -> (string)

The type of the connector.

applianceFqdn -> (string)

The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.

secretArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

state -> (string)

The state of the connector.

stateDetails -> (string)

A detailed description of the connector state.

status -> (string)

The status of the connector.

checks -> (list)

A list of checks that are run on the connector.

(structure)

A check on a connector to identify connectivity health.

type -> (string)

The check type.

result -> (string)

The check result.

lastCheckAttempt -> (timestamp)

The date and time of the last check attempt.

impairedSince -> (timestamp)

The time when connector health began to be impaired.

createdAt -> (timestamp)

The date and time that the connector was created.

modifiedAt -> (timestamp)

The date and time that the connector was modified.