Describe Asset Bundle Import Job

quicksight_describe_asset_bundle_import_job

R Documentation

Describes an existing import job

Description

Describes an existing import job.

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

Usage

quicksight_describe_asset_bundle_import_job(AwsAccountId,
  AssetBundleImportJobId)

Arguments

AwsAccountId

[required] The ID of the Amazon Web Services account the import job was executed in.

AssetBundleImportJobId

[required] The ID of the job. The job ID is set when you start a new job with a start_asset_bundle_import_job API call.

Value

A list with the following syntax:

list(
  JobStatus = "QUEUED_FOR_IMMEDIATE_EXECUTION"|"IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|"FAILED_ROLLBACK_IN_PROGRESS"|"FAILED_ROLLBACK_COMPLETED"|"FAILED_ROLLBACK_ERROR",
  Errors = list(
    list(
      Arn = "string",
      Type = "string",
      Message = "string"
    )
  ),
  RollbackErrors = list(
    list(
      Arn = "string",
      Type = "string",
      Message = "string"
    )
  ),
  Arn = "string",
  CreatedTime = as.POSIXct(
    "2015-01-01"
  ),
  AssetBundleImportJobId = "string",
  AwsAccountId = "string",
  AssetBundleImportSource = list(
    Body = "string",
    S3Uri = "string"
  ),
  OverrideParameters = list(
    ResourceIdOverrideConfiguration = list(
      PrefixForAllResources = "string"
    ),
    VPCConnections = list(
      list(
        VPCConnectionId = "string",
        Name = "string",
        SubnetIds = list(
          "string"
        ),
        SecurityGroupIds = list(
          "string"
        ),
        DnsResolvers = list(
          "string"
        ),
        RoleArn = "string"
      )
    ),
    RefreshSchedules = list(
      list(
        DataSetId = "string",
        ScheduleId = "string",
        StartAfterDateTime = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    DataSources = list(
      list(
        DataSourceId = "string",
        Name = "string",
        DataSourceParameters = list(
          AmazonElasticsearchParameters = list(
            Domain = "string"
          ),
          AthenaParameters = list(
            WorkGroup = "string",
            RoleArn = "string"
          ),
          AuroraParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          AuroraPostgreSqlParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          AwsIotAnalyticsParameters = list(
            DataSetName = "string"
          ),
          JiraParameters = list(
            SiteBaseUrl = "string"
          ),
          MariaDbParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          MySqlParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          OracleParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          PostgreSqlParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          PrestoParameters = list(
            Host = "string",
            Port = 123,
            Catalog = "string"
          ),
          RdsParameters = list(
            InstanceId = "string",
            Database = "string"
          ),
          RedshiftParameters = list(
            Host = "string",
            Port = 123,
            Database = "string",
            ClusterId = "string",
            IAMParameters = list(
              RoleArn = "string",
              DatabaseUser = "string",
              DatabaseGroups = list(
                "string"
              ),
              AutoCreateDatabaseUser = TRUE|FALSE
            ),
            IdentityCenterConfiguration = list(
              EnableIdentityPropagation = TRUE|FALSE
            )
          ),
          S3Parameters = list(
            ManifestFileLocation = list(
              Bucket = "string",
              Key = "string"
            ),
            RoleArn = "string"
          ),
          ServiceNowParameters = list(
            SiteBaseUrl = "string"
          ),
          SnowflakeParameters = list(
            Host = "string",
            Database = "string",
            Warehouse = "string"
          ),
          SparkParameters = list(
            Host = "string",
            Port = 123
          ),
          SqlServerParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          TeradataParameters = list(
            Host = "string",
            Port = 123,
            Database = "string"
          ),
          TwitterParameters = list(
            Query = "string",
            MaxRows = 123
          ),
          AmazonOpenSearchParameters = list(
            Domain = "string"
          ),
          ExasolParameters = list(
            Host = "string",
            Port = 123
          ),
          DatabricksParameters = list(
            Host = "string",
            Port = 123,
            SqlEndpointPath = "string"
          ),
          StarburstParameters = list(
            Host = "string",
            Port = 123,
            Catalog = "string",
            ProductType = "GALAXY"|"ENTERPRISE"
          ),
          TrinoParameters = list(
            Host = "string",
            Port = 123,
            Catalog = "string"
          ),
          BigQueryParameters = list(
            ProjectId = "string",
            DataSetRegion = "string"
          )
        ),
        VpcConnectionProperties = list(
          VpcConnectionArn = "string"
        ),
        SslProperties = list(
          DisableSsl = TRUE|FALSE
        ),
        Credentials = list(
          CredentialPair = list(
            Username = "string",
            Password = "string"
          ),
          SecretArn = "string"
        )
      )
    ),
    DataSets = list(
      list(
        DataSetId = "string",
        Name = "string"
      )
    ),
    Themes = list(
      list(
        ThemeId = "string",
        Name = "string"
      )
    ),
    Analyses = list(
      list(
        AnalysisId = "string",
        Name = "string"
      )
    ),
    Dashboards = list(
      list(
        DashboardId = "string",
        Name = "string"
      )
    )
  ),
  FailureAction = "DO_NOTHING"|"ROLLBACK",
  RequestId = "string",
  Status = 123,
  OverridePermissions = list(
    DataSources = list(
      list(
        DataSourceIds = list(
          "string"
        ),
        Permissions = list(
          Principals = list(
            "string"
          ),
          Actions = list(
            "string"
          )
        )
      )
    ),
    DataSets = list(
      list(
        DataSetIds = list(
          "string"
        ),
        Permissions = list(
          Principals = list(
            "string"
          ),
          Actions = list(
            "string"
          )
        )
      )
    ),
    Themes = list(
      list(
        ThemeIds = list(
          "string"
        ),
        Permissions = list(
          Principals = list(
            "string"
          ),
          Actions = list(
            "string"
          )
        )
      )
    ),
    Analyses = list(
      list(
        AnalysisIds = list(
          "string"
        ),
        Permissions = list(
          Principals = list(
            "string"
          ),
          Actions = list(
            "string"
          )
        )
      )
    ),
    Dashboards = list(
      list(
        DashboardIds = list(
          "string"
        ),
        Permissions = list(
          Principals = list(
            "string"
          ),
          Actions = list(
            "string"
          )
        ),
        LinkSharingConfiguration = list(
          Permissions = list(
            Principals = list(
              "string"
            ),
            Actions = list(
              "string"
            )
          )
        )
      )
    )
  ),
  OverrideTags = list(
    VPCConnections = list(
      list(
        VPCConnectionIds = list(
          "string"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        )
      )
    ),
    DataSources = list(
      list(
        DataSourceIds = list(
          "string"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        )
      )
    ),
    DataSets = list(
      list(
        DataSetIds = list(
          "string"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        )
      )
    ),
    Themes = list(
      list(
        ThemeIds = list(
          "string"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        )
      )
    ),
    Analyses = list(
      list(
        AnalysisIds = list(
          "string"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        )
      )
    ),
    Dashboards = list(
      list(
        DashboardIds = list(
          "string"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        )
      )
    )
  ),
  OverrideValidationStrategy = list(
    StrictModeForAllResources = TRUE|FALSE
  ),
  Warnings = list(
    list(
      Arn = "string",
      Message = "string"
    )
  )
)

Request syntax

svc$describe_asset_bundle_import_job(
  AwsAccountId = "string",
  AssetBundleImportJobId = "string"
)