create-job¶

Description¶

This operation creates a job.

Synopsis¶

  create-job
--details <value>
--type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--details (structure)

The details for the CreateJob request.

ExportAssetToSignedUrl -> (structure)

Details about the export to signed URL request.

AssetId -> (string)

The unique identifier for the asset that is exported to a signed URL.

DataSetId -> (string)

The unique identifier for the data set associated with this export job.

RevisionId -> (string)

The unique identifier for the revision associated with this export request.

ExportAssetsToS3 -> (structure)

Details about the export to Amazon S3 request.

AssetDestinations -> (list)

The destination for the asset.

(structure)

The destination for the asset.

AssetId -> (string)

The unique identifier for the asset.

Bucket -> (string)

The S3 bucket that is the destination for the asset.

Key -> (string)

The name of the object in Amazon S3 for the asset.

DataSetId -> (string)

The unique identifier for the data set associated with this export job.

Encryption -> (structure)

Encryption configuration for the export job.

KmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

Type -> (string)

The type of server side encryption used for encrypting the objects in Amazon S3.

RevisionId -> (string)

The unique identifier for the revision associated with this export request.

ExportRevisionsToS3 -> (structure)

Details about the export to Amazon S3 request.

DataSetId -> (string)

The unique identifier for the data set associated with this export job.

Encryption -> (structure)

Encryption configuration for the export job.

KmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

Type -> (string)

The type of server side encryption used for encrypting the objects in Amazon S3.

RevisionDestinations -> (list)

The destination for the revision.

(structure)

The destination where the assets in the revision will be exported.

Bucket -> (string)

The S3 bucket that is the destination for the assets in the revision.

KeyPattern -> (string)

A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .

RevisionId -> (string)

The unique identifier for the revision.

ImportAssetFromSignedUrl -> (structure)

Details about the import from signed URL request.

AssetName -> (string)

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.

DataSetId -> (string)

The unique identifier for the data set associated with this import job.

Md5Hash -> (string)

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

RevisionId -> (string)

The unique identifier for the revision associated with this import request.

ImportAssetsFromS3 -> (structure)

Details about the import from Amazon S3 request.

AssetSources -> (list)

Is a list of S3 bucket and object key pairs.

(structure)

The source of the assets.

Bucket -> (string)

The S3 bucket that’s part of the source of the asset.

Key -> (string)

The name of the object in Amazon S3 for the asset.

DataSetId -> (string)

The unique identifier for the data set associated with this import job.

RevisionId -> (string)

The unique identifier for the revision associated with this import request.

ImportAssetsFromRedshiftDataShares -> (structure)

Details from an import from Amazon Redshift datashare request.

AssetSources -> (list)

A list of Amazon Redshift datashare assets.

(structure)

The source of the Amazon Redshift datashare asset.

DataShareArn -> (string)

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

DataSetId -> (string)

The unique identifier for the data set associated with this import job.

RevisionId -> (string)

The unique identifier for the revision associated with this import job.

ImportAssetFromApiGatewayApi -> (structure)

Information about the import asset from API Gateway API request.

ApiDescription -> (string)

The API description. Markdown supported.

ApiId -> (string)

The API Gateway API ID.

ApiKey -> (string)

The API Gateway API key.

ApiName -> (string)

The API name.

ApiSpecificationMd5Hash -> (string)

The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.

DataSetId -> (string)

The data set ID.

ProtocolType -> (string)

The protocol type.

RevisionId -> (string)

The revision ID.

Stage -> (string)

The API stage.

JSON Syntax:

{
  "ExportAssetToSignedUrl": {
    "AssetId": "string",
    "DataSetId": "string",
    "RevisionId": "string"
  },
  "ExportAssetsToS3": {
    "AssetDestinations": [
      {
        "AssetId": "string",
        "Bucket": "string",
        "Key": "string"
      }
      ...
    ],
    "DataSetId": "string",
    "Encryption": {
      "KmsKeyArn": "string",
      "Type": "aws:kms"|"AES256"
    },
    "RevisionId": "string"
  },
  "ExportRevisionsToS3": {
    "DataSetId": "string",
    "Encryption": {
      "KmsKeyArn": "string",
      "Type": "aws:kms"|"AES256"
    },
    "RevisionDestinations": [
      {
        "Bucket": "string",
        "KeyPattern": "string",
        "RevisionId": "string"
      }
      ...
    ]
  },
  "ImportAssetFromSignedUrl": {
    "AssetName": "string",
    "DataSetId": "string",
    "Md5Hash": "string",
    "RevisionId": "string"
  },
  "ImportAssetsFromS3": {
    "AssetSources": [
      {
        "Bucket": "string",
        "Key": "string"
      }
      ...
    ],
    "DataSetId": "string",
    "RevisionId": "string"
  },
  "ImportAssetsFromRedshiftDataShares": {
    "AssetSources": [
      {
        "DataShareArn": "string"
      }
      ...
    ],
    "DataSetId": "string",
    "RevisionId": "string"
  },
  "ImportAssetFromApiGatewayApi": {
    "ApiDescription": "string",
    "ApiId": "string",
    "ApiKey": "string",
    "ApiName": "string",
    "ApiSpecificationMd5Hash": "string",
    "DataSetId": "string",
    "ProtocolType": "REST",
    "RevisionId": "string",
    "Stage": "string"
  }
}

--type (string)

The type of job to be created.

Possible values:

IMPORT_ASSETS_FROM_S3

IMPORT_ASSET_FROM_SIGNED_URL

EXPORT_ASSETS_TO_S3

EXPORT_ASSET_TO_SIGNED_URL

EXPORT_REVISIONS_TO_S3

IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES

IMPORT_ASSET_FROM_API_GATEWAY_API

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

See ‘aws help’ for descriptions of global parameters.

Output¶

Arn -> (string)

The ARN for the job.

CreatedAt -> (timestamp)

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

Details -> (structure)

Details about the job.

ExportAssetToSignedUrl -> (structure)

Details for the export to signed URL response.

AssetId -> (string)

The unique identifier for the asset associated with this export job.

DataSetId -> (string)

The unique identifier for the data set associated with this export job.

RevisionId -> (string)

The unique identifier for the revision associated with this export response.

SignedUrl -> (string)

The signed URL for the export request.

SignedUrlExpiresAt -> (timestamp)

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

ExportAssetsToS3 -> (structure)

Details for the export to Amazon S3 response.

AssetDestinations -> (list)

The destination in Amazon S3 where the asset is exported.

(structure)

The destination for the asset.

AssetId -> (string)

The unique identifier for the asset.

Bucket -> (string)

The S3 bucket that is the destination for the asset.

Key -> (string)

The name of the object in Amazon S3 for the asset.

DataSetId -> (string)

The unique identifier for the data set associated with this export job.

Encryption -> (structure)

Encryption configuration of the export job.

KmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

Type -> (string)

The type of server side encryption used for encrypting the objects in Amazon S3.

RevisionId -> (string)

The unique identifier for the revision associated with this export response.

ExportRevisionsToS3 -> (structure)

Details for the export revisions to Amazon S3 response.

DataSetId -> (string)

The unique identifier for the data set associated with this export job.

Encryption -> (structure)

Encryption configuration of the export job.

KmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

Type -> (string)

The type of server side encryption used for encrypting the objects in Amazon S3.

RevisionDestinations -> (list)

The destination in Amazon S3 where the revision is exported.

(structure)

The destination where the assets in the revision will be exported.

Bucket -> (string)

The S3 bucket that is the destination for the assets in the revision.

KeyPattern -> (string)

A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .

RevisionId -> (string)

The unique identifier for the revision.

EventActionArn -> (string)

The Amazon Resource Name (ARN) of the event action.

ImportAssetFromSignedUrl -> (structure)

Details for the import from signed URL response.

AssetName -> (string)

The name for the asset associated with this import job.

DataSetId -> (string)

The unique identifier for the data set associated with this import job.

Md5Hash -> (string)

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

RevisionId -> (string)

The unique identifier for the revision associated with this import response.

SignedUrl -> (string)

The signed URL.

SignedUrlExpiresAt -> (timestamp)

The time and date at which the signed URL expires, in ISO 8601 format.

ImportAssetsFromS3 -> (structure)

Details for the import from Amazon S3 response.

AssetSources -> (list)

Is a list of Amazon S3 bucket and object key pairs.

(structure)

The source of the assets.

Bucket -> (string)

The S3 bucket that’s part of the source of the asset.

Key -> (string)

The name of the object in Amazon S3 for the asset.

DataSetId -> (string)

The unique identifier for the data set associated with this import job.

RevisionId -> (string)

The unique identifier for the revision associated with this import response.

ImportAssetsFromRedshiftDataShares -> (structure)

Details from an import from Amazon Redshift datashare response.

AssetSources -> (list)

A list of Amazon Redshift datashare asset sources.

(structure)

The source of the Amazon Redshift datashare asset.

DataShareArn -> (string)

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

DataSetId -> (string)

The unique identifier for the data set associated with this import job.

RevisionId -> (string)

The unique identifier for the revision associated with this import job.

ImportAssetFromApiGatewayApi -> (structure)

The response details.

ApiDescription -> (string)

The API description.

ApiId -> (string)

The API ID.

ApiKey -> (string)

The API key.

ApiName -> (string)

The API name.

ApiSpecificationMd5Hash -> (string)

The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.

ApiSpecificationUploadUrl -> (string)

The upload URL of the API specification.

ApiSpecificationUploadUrlExpiresAt -> (timestamp)

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

DataSetId -> (string)

The data set ID.

ProtocolType -> (string)

The protocol type.

RevisionId -> (string)

The revision ID.

Stage -> (string)

The API stage.

Errors -> (list)

The errors associated with jobs.

(structure)

An error that occurred with the job request.

Code -> (string)

The code for the job error.

Details -> (structure)

The details about the job error.

ImportAssetFromSignedUrlJobErrorDetails -> (structure)

Information about the job error.

AssetName -> (string)

Information about the job error.

ImportAssetsFromS3JobErrorDetails -> (list)

Information about the job error.

(structure)

The source of the assets.

Bucket -> (string)

The S3 bucket that’s part of the source of the asset.

Key -> (string)

The name of the object in Amazon S3 for the asset.

LimitName -> (string)

The name of the limit that was reached.

LimitValue -> (double)

The value of the exceeded limit.

Message -> (string)

The message related to the job error.

ResourceId -> (string)

The unique identifier for the resource related to the error.

ResourceType -> (string)

The type of resource related to the error.

Id -> (string)

The unique identifier for the job.

State -> (string)

The state of the job.

Type -> (string)

The job type.

UpdatedAt -> (timestamp)

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

Table of Contents

Feedback

User Guide

create-job¶

Description¶

Synopsis¶

Options¶

Output¶