AWS CLI Command Reference

[ aws . dataexchange ]

get-asset

Description

This operation returns information about an asset.

See also: AWS API Documentation

Synopsis

  get-asset
--asset-id <value>
--data-set-id <value>
--revision-id <value>
[--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

--asset-id (string)

The unique identifier for an asset.

--data-set-id (string)

The unique identifier for a data set.

--revision-id (string)

The unique identifier for a revision.

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

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

Arn -> (string)

The ARN for the asset.

AssetDetails -> (structure)

Details about the asset.

S3SnapshotAsset -> (structure)

The Amazon S3 object that is the asset.

Size -> (double)

The size of the Amazon S3 object that is the object.

RedshiftDataShareAsset -> (structure)

The Amazon Redshift datashare that is the asset.

Arn -> (string)

The Amazon Resource Name (ARN) of the datashare asset.

ApiGatewayApiAsset -> (structure)

Information about the API Gateway API asset.

ApiDescription -> (string)

The API description of the API asset.

ApiEndpoint -> (string)

The API endpoint of the API asset.

ApiId -> (string)

The unique identifier of the API asset.

ApiKey -> (string)

The API key of the API asset.

ApiName -> (string)

The API name of the API asset.

ApiSpecificationDownloadUrl -> (string)

The download URL of the API specification of the API asset.

ApiSpecificationDownloadUrlExpiresAt -> (timestamp)

The date and time that the upload URL expires, in ISO 8601 format.

ProtocolType -> (string)

The protocol type of the API asset.

Stage -> (string)

The stage of the API asset.

S3DataAccessAsset -> (structure)

The Amazon S3 data access that is the asset.

Bucket -> (string)

The Amazon S3 bucket hosting data to be shared in the S3 data access.

KeyPrefixes -> (list)

The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.

(string)

Keys -> (list)

S3 keys made available using this asset.

(string)

S3AccessPointAlias -> (string)

The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.

S3AccessPointArn -> (string)

The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.

LakeFormationDataPermissionAsset -> (structure)

The AWS Lake Formation data permission that is the asset.

LakeFormationDataPermissionDetails -> (structure)

Details about the AWS Lake Formation data permission.

LFTagPolicy -> (structure)

Details about the LF-tag policy.

CatalogId -> (string)

The identifier for the AWS Glue Data Catalog.

ResourceType -> (string)

The resource type for which the LF-tag policy applies.

ResourceDetails -> (structure)

Details for the Lake Formation Resources included in the LF-tag policy.

Database -> (structure)

Details about the database resource included in the AWS Lake Formation data permission.

Expression -> (list)

A list of LF-tag conditions that apply to database resources.

(structure)

A structure that allows an LF-admin to grant permissions on certain conditions.

TagKey -> (string)

The key name for the LF-tag.

TagValues -> (list)

A list of LF-tag values.

(string)

Table -> (structure)

Details about the table resource included in the AWS Lake Formation data permission.

Expression -> (list)

A list of LF-tag conditions that apply to table resources.

(structure)

A structure that allows an LF-admin to grant permissions on certain conditions.

TagKey -> (string)

The key name for the LF-tag.

TagValues -> (list)

A list of LF-tag values.

(string)

LakeFormationDataPermissionType -> (string)

The data permission type.

Permissions -> (list)

The permissions granted to the subscribers on the resource.

(string)

RoleArn -> (string)

The IAM role’s ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions to AWS Lake Formation data permissions.

AssetType -> (string)

The type of asset that is added to a data set.

CreatedAt -> (timestamp)

The date and time that the asset was created, in ISO 8601 format.

DataSetId -> (string)

The unique identifier for the data set associated with this asset.

Id -> (string)

The unique identifier for the asset.

Name -> (string)

The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of “Database(s) included in the LF-tag policy” or “Table(s) included in the LF-tag policy” are used as the asset name.

RevisionId -> (string)

The unique identifier for the revision associated with this asset.

SourceId -> (string)

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

UpdatedAt -> (timestamp)

The date and time that the asset was last updated, in ISO 8601 format.

© Copyright 2018, Amazon Web Services. Created using Sphinx.