[ aws . redshift ]

associate-data-share-consumer

Description

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.

See also: AWS API Documentation

Synopsis

  associate-data-share-consumer
--data-share-arn <value>
[--associate-entire-account | --no-associate-entire-account]
[--consumer-arn <value>]
[--consumer-region <value>]
[--allow-writes | --no-allow-writes]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--data-share-arn (string)

The Amazon Resource Name (ARN) of the datashare that the consumer is to use.

--associate-entire-account | --no-associate-entire-account (boolean)

A value that specifies whether the datashare is associated with the entire account.

--consumer-arn (string)

The Amazon Resource Name (ARN) of the consumer namespace associated with the datashare.

--consumer-region (string)

From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

--allow-writes | --no-allow-writes (boolean)

If set to true, allows write operations for a datashare.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

DataShareArn -> (string)

The Amazon Resource Name (ARN) of the datashare that the consumer is to use.

ProducerArn -> (string)

The Amazon Resource Name (ARN) of the producer namespace.

AllowPubliclyAccessibleConsumers -> (boolean)

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DataShareAssociations -> (list)

A value that specifies when the datashare has an association between producer and data consumers.

(structure)

The association of a datashare from a producer account with a data consumer.

ConsumerIdentifier -> (string)

The name of the consumer accounts that have an association with a producer datashare.

Status -> (string)

The status of the datashare that is associated.

ConsumerRegion -> (string)

The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare.

CreatedDate -> (timestamp)

The creation date of the datashare that is associated.

StatusChangeDate -> (timestamp)

The status change data of the datashare that is associated.

ProducerAllowedWrites -> (boolean)

Specifies whether write operations were allowed during data share authorization.

ConsumerAcceptedWrites -> (boolean)

Specifies whether write operations were allowed during data share association.

ManagedBy -> (string)

The identifier of a datashare to show its managing entity.