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

modify-integration

Description

Modifies a Zero-ETL integration in the caller's account.

See also: AWS API Documentation

Synopsis

  modify-integration
--integration-identifier <value>
[--description <value>]
[--data-filter <value>]
[--integration-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

--integration-identifier (string)

The Amazon Resource Name (ARN) for the integration.

--description (string)

A description of the integration.

--data-filter (string)

Selects source tables for the integration using Maxwell filter syntax.

--integration-name (string)

A unique name for an integration in Glue.

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

SourceArn -> (string)

The ARN of the source for the integration.

TargetArn -> (string)

The ARN of the target for the integration.

IntegrationName -> (string)

A unique name for an integration in Glue.

Description -> (string)

A description of the integration.

IntegrationArn -> (string)

The Amazon Resource Name (ARN) for the integration.

KmsKeyId -> (string)

The ARN of a KMS key used for encrypting the channel.

AdditionalEncryptionContext -> (map)

An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

key -> (string)

value -> (string)

Tags -> (list)

Metadata assigned to the resource consisting of a list of key-value pairs.

(structure)

The Tag object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

For more information about tags, and controlling access to resources in Glue, see Amazon Web Services Tags in Glue and Specifying Glue Resource ARNs in the developer guide.

key -> (string)

The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.

value -> (string)

The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.

Status -> (string)

The status of the integration being modified.

The possible statuses are:

  • CREATING: The integration is being created.
  • ACTIVE: The integration creation succeeds.
  • MODIFYING: The integration is being modified.
  • FAILED: The integration creation fails.
  • DELETING: The integration is deleted.
  • SYNCING: The integration is synchronizing.
  • NEEDS_ATTENTION: The integration needs attention, such as synchronization.

CreateTime -> (timestamp)

The time when the integration was created, in UTC.

Errors -> (list)

A list of errors associated with the integration modification.

(structure)

An error associated with a zero-ETL integration.

ErrorCode -> (string)

The code associated with this error.

ErrorMessage -> (string)

A message describing the error.

DataFilter -> (string)

Selects source tables for the integration using Maxwell filter syntax.