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

start-asset-bundle-export-job

Description

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

See also: AWS API Documentation

Synopsis

  start-asset-bundle-export-job
--aws-account-id <value>
--asset-bundle-export-job-id <value>
--resource-arns <value>
[--include-all-dependencies | --no-include-all-dependencies]
--export-format <value>
[--cloud-formation-override-property-configuration <value>]
[--include-permissions | --no-include-permissions]
[--include-tags | --no-include-tags]
[--validation-strategy <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

--aws-account-id (string)

The ID of the Amazon Web Services account to export assets from.

--asset-bundle-export-job-id (string)

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

--resource-arns (list)

An array of resource ARNs to export. The following resources are supported.

  • Analysis
  • Dashboard
  • DataSet
  • DataSource
  • RefreshSchedule
  • Theme
  • VPCConnection

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

(string)

Syntax:

"string" "string" ...

--include-all-dependencies | --no-include-all-dependencies (boolean)

A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE , any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

--export-format (string)

The export data format.

Possible values:

  • CLOUDFORMATION_JSON
  • QUICKSIGHT_JSON

--cloud-formation-override-property-configuration (structure)

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON .

ResourceIdOverrideConfiguration -> (structure)

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

PrefixForAllResources -> (boolean)

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

VPCConnections -> (list)

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

(structure)

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

Arn -> (string)

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

Properties -> (list)

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

(string)

RefreshSchedules -> (list)

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

(structure)

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

Arn -> (string)

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

Properties -> (list)

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

(string)

DataSources -> (list)

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

(structure)

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

Arn -> (string)

The ARN of the specific DataSource resource whose override properties are configured in this structure.

Properties -> (list)

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

(string)

DataSets -> (list)

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

(structure)

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

Arn -> (string)

The ARN of the specific DataSet resource whose override properties are configured in this structure.

Properties -> (list)

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

(string)

Themes -> (list)

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

(structure)

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

Arn -> (string)

The ARN of the specific Theme resource whose override properties are configured in this structure.

Properties -> (list)

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

(string)

Analyses -> (list)

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

(structure)

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

Arn -> (string)

The ARN of the specific Analysis resource whose override properties are configured in this structure.

Properties -> (list)

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

(string)

Dashboards -> (list)

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

(structure)

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

Arn -> (string)

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

Properties -> (list)

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

(string)

JSON Syntax:

{
  "ResourceIdOverrideConfiguration": {
    "PrefixForAllResources": true|false
  },
  "VPCConnections": [
    {
      "Arn": "string",
      "Properties": ["Name"|"DnsResolvers"|"RoleArn", ...]
    }
    ...
  ],
  "RefreshSchedules": [
    {
      "Arn": "string",
      "Properties": ["StartAfterDateTime", ...]
    }
    ...
  ],
  "DataSources": [
    {
      "Arn": "string",
      "Properties": ["Name"|"DisableSsl"|"SecretArn"|"Username"|"Password"|"Domain"|"WorkGroup"|"Host"|"Port"|"Database"|"DataSetName"|"Catalog"|"InstanceId"|"ClusterId"|"ManifestFileLocation"|"Warehouse"|"RoleArn"|"ProductType", ...]
    }
    ...
  ],
  "DataSets": [
    {
      "Arn": "string",
      "Properties": ["Name", ...]
    }
    ...
  ],
  "Themes": [
    {
      "Arn": "string",
      "Properties": ["Name", ...]
    }
    ...
  ],
  "Analyses": [
    {
      "Arn": "string",
      "Properties": ["Name", ...]
    }
    ...
  ],
  "Dashboards": [
    {
      "Arn": "string",
      "Properties": ["Name", ...]
    }
    ...
  ]
}

--include-permissions | --no-include-permissions (boolean)

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE , any permissions associated with each resource are exported.

--include-tags | --no-include-tags (boolean)

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE , any tags associated with each resource are exported.

--validation-strategy (structure)

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE , strict validation for every error is enforced. If it is set to FALSE , validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE .

StrictModeForAllResources -> (boolean)

A Boolean value that indicates whether to export resources under strict or lenient mode.

Shorthand Syntax:

StrictModeForAllResources=boolean

JSON Syntax:

{
  "StrictModeForAllResources": true|false
}

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

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

Arn -> (string)

The Amazon Resource Name (ARN) for the export job.

AssetBundleExportJobId -> (string)

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

RequestId -> (string)

The Amazon Web Services response ID for this operation.

Status -> (integer)

The HTTP status of the response.