1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package backup
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/backup/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Returns metadata associated with a restore job that is specified by a job ID.
func (c *Client) DescribeRestoreJob(ctx context.Context, params *DescribeRestoreJobInput, optFns ...func(*Options)) (*DescribeRestoreJobOutput, error) {
if params == nil {
params = &DescribeRestoreJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeRestoreJob", params, optFns, c.addOperationDescribeRestoreJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeRestoreJobOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeRestoreJobInput struct {
// Uniquely identifies the job that restores a recovery point.
//
// This member is required.
RestoreJobId *string
noSmithyDocumentSerde
}
type DescribeRestoreJobOutput struct {
// Returns the account ID that owns the restore job.
AccountId *string
// The size, in bytes, of the restored resource.
BackupSizeInBytes *int64
// The date and time that a job to restore a recovery point is completed, in Unix
// format and Coordinated Universal Time (UTC). The value of CompletionDate is
// accurate to milliseconds. For example, the value 1516925490.087 represents
// Friday, January 26, 2018 12:11:30.087 AM.
CompletionDate *time.Time
// Contains identifying information about the creation of a restore job.
CreatedBy *types.RestoreJobCreator
// An Amazon Resource Name (ARN) that uniquely identifies a resource whose
// recovery point is being restored. The format of the ARN depends on the resource
// type of the backed-up resource.
CreatedResourceArn *string
// The date and time that a restore job is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// This notes the status of the data generated by the restore test. The status may
// be Deleting , Failed , or Successful .
DeletionStatus types.RestoreDeletionStatus
// This describes the restore job deletion status.
DeletionStatusMessage *string
// The amount of time in minutes that a job restoring a recovery point is expected
// to take.
ExpectedCompletionTimeMinutes *int64
// Specifies the IAM role ARN used to create the target recovery point; for
// example, arn:aws:iam::123456789012:role/S3Access .
IamRoleArn *string
// Contains an estimated percentage that is complete of a job at the time the job
// status was queried.
PercentDone *string
// An ARN that uniquely identifies a recovery point; for example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
RecoveryPointArn *string
// This is the creation date of the recovery point made by the specifed restore
// job.
RecoveryPointCreationDate *time.Time
// Returns metadata associated with a restore job listed by resource type.
ResourceType *string
// Uniquely identifies the job that restores a recovery point.
RestoreJobId *string
// Status code specifying the state of the job that is initiated by Backup to
// restore a recovery point.
Status types.RestoreJobStatus
// A message showing the status of a job to restore a recovery point.
StatusMessage *string
// This is the status of validation run on the indicated restore job.
ValidationStatus types.RestoreValidationStatus
// This describes the status of validation run on the indicated restore job.
ValidationStatusMessage *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeRestoreJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeRestoreJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeRestoreJob{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeRestoreJob"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeRestoreJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeRestoreJob(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeRestoreJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeRestoreJob",
}
}
|