Values_2.DescribeDashboardSnapshotJobResultResponseSourceDescribes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.. Registered user support This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The job was started by a different user. The registered user doesn't have access to the specified dashboard. The request succeeds but the job fails in the following scenarios: DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard. CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats. The request succeeds but the response contains an error code in the following scenarios: CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats. RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings. CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings. DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.
type nonrec t = {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.
*)jobStatus : SnapshotJobStatus.t option;Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.
*)createdTime : Values_0.Timestamp.t option;The time that a snapshot job was created.
*)lastUpdatedTime : Values_0.Timestamp.t option;The time that a snapshot job status was last updated.
*)result : SnapshotJobResult.t option;The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
*)errorInfo : SnapshotJobErrorInfo.t option;Displays information for the error that caused a job to fail.
*)requestId : Values_0.NonEmptyString.t option;The Amazon Web Services request ID for this operation.
*)status : Values_1.StatusCode.t option;The HTTP status of the request
*)}type nonrec error = [ | `AccessDeniedException of Values_0.AccessDeniedException.t| `InternalFailureException of Values_1.InternalFailureException.t| `InvalidParameterValueException of Values_1.InvalidParameterValueException.t| `PreconditionNotMetException of Values_1.PreconditionNotMetException.t| `ResourceNotFoundException of Values_1.ResourceNotFoundException.t| `ThrottlingException of Values_1.ThrottlingException.t| `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t| `Unknown_operation_error of string * string option ]val error_of_json :
string ->
Yojson.Safe.t ->
[> `AccessDeniedException of Values_0.AccessDeniedException.t
| `InternalFailureException of Values_1.InternalFailureException.t
| `InvalidParameterValueException of
Values_1.InvalidParameterValueException.t
| `PreconditionNotMetException of Values_1.PreconditionNotMetException.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 ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `AccessDeniedException of Values_0.AccessDeniedException.t
| `InternalFailureException of Values_1.InternalFailureException.t
| `InvalidParameterValueException of
Values_1.InvalidParameterValueException.t
| `PreconditionNotMetException of Values_1.PreconditionNotMetException.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 ]val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Integer of Values_1.StatusCode.t
| `String of Values_0.Arn.t
| `Structure of
(string
* [> `List of
[> `Structure of
(string
* [> `List of
[> `Structure of
(string
* [> `List of
[> `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
| `String of string
| `Structure of
(string
* [> `Structure of
(string
* [>
`String of
string ])
list ])
list ])
list ]
list ])
list ]
list ])
list ]
list
| `String of Values_0.String_.t ])
list
| `Timestamp of Values_0.Timestamp.t ])
list ]