Module Values_2.DescribeDashboardSnapshotJobResponseSource

Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus. Registered user support This API can be called as before to get status of a job started by the same Quick Sight user. Possible error scenarios Request will fail with an Access Denied error in the following scenarios: The credentials have expired. Job has been started by a different user. Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.

Sourcetype nonrec t = {
  1. awsAccountId : Values_1.AwsAccountId.t option;
    (*

    The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

    *)
  2. dashboardId : Values_0.ShortRestrictiveResourceId.t option;
    (*

    The ID of the dashboard that you have started a snapshot job for.

    *)
  3. snapshotJobId : Values_0.ShortRestrictiveResourceId.t option;
    (*

    The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

    *)
  4. userConfiguration : SnapshotUserConfigurationRedacted.t option;
    (*

    The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

    *)
  5. snapshotConfiguration : SnapshotConfiguration.t option;
    (*

    The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

    *)
  6. arn : Values_0.Arn.t option;
    (*

    The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

    *)
  7. jobStatus : SnapshotJobStatus.t option;
    (*

    Indicates the status of a job. The status updates as the job executes. This shows one of the following values. COMPLETED - The job was completed successfully. FAILED - The job failed to execute. QUEUED - The job is queued and hasn't started yet. RUNNING - The job is still running.

    *)
  8. createdTime : Values_0.Timestamp.t option;
    (*

    The time that the snapshot job was created.

    *)
  9. lastUpdatedTime : Values_0.Timestamp.t option;
    (*

    The time that the snapshot job status was last updated.

    *)
  10. requestId : Values_0.NonEmptyString.t option;
    (*

    The Amazon Web Services request ID for this operation.

    *)
  11. status : Values_1.StatusCode.t option;
    (*

    The HTTP status of the request

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of Values_0.AccessDeniedException.t
  2. | `InternalFailureException of Values_1.InternalFailureException.t
  3. | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t
  4. | `ThrottlingException of Values_1.ThrottlingException.t
  5. | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?awsAccountId:??? -> ?dashboardId:??? -> ?snapshotJobId:??? -> ?userConfiguration:??? -> ?snapshotConfiguration:??? -> ?arn:??? -> ?jobStatus:??? -> ?createdTime:??? -> ?lastUpdatedTime:??? -> ?requestId:??? -> ?status:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalFailureException of Values_1.InternalFailureException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalFailureException of Values_1.InternalFailureException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of Values_1.StatusCode.t | `String of Values_1.AwsAccountId.t | `Structure of (string * [> `List of [> `Structure of (string * [> `List of [> `String of Values_1.SessionTagKey.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `String of string ] list | `String of Values_0.ShortRestrictiveResourceId.t ]) list ] list ]) list ] list ]) list ] list | `Structure of (string * [> `List of [> `Structure of (string * [> `List of [> `Double of Values_0.SensitiveDouble.t | `Long of Values_0.SensitiveLong.t | `String of Values_0.SensitiveString.t | `Timestamp of Values_0.SensitiveTimestamp.t ] list | `String of Values_0.NonEmptyString.t | `Structure of (string * [> `String of string ]) list ]) list ] list ]) list ]) list | `Timestamp of Values_0.Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t