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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package ssm
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/ssm/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Gets the contents of the specified Amazon Web Services Systems Manager document
// (SSM document).
func (c *Client) GetDocument(ctx context.Context, params *GetDocumentInput, optFns ...func(*Options)) (*GetDocumentOutput, error) {
if params == nil {
params = &GetDocumentInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetDocument", params, optFns, c.addOperationGetDocumentMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetDocumentOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetDocumentInput struct {
// The name of the SSM document.
//
// This member is required.
Name *string
// Returns the document in the specified format. The document format can be either
// JSON or YAML. JSON is the default format.
DocumentFormat types.DocumentFormat
// The document version for which you want information.
DocumentVersion *string
// An optional field specifying the version of the artifact associated with the
// document. For example, "Release 12, Update 6". This value is unique across all
// versions of a document and can't be changed.
VersionName *string
noSmithyDocumentSerde
}
type GetDocumentOutput struct {
// A description of the document attachments, including names, locations, sizes,
// and so on.
AttachmentsContent []types.AttachmentContent
// The contents of the SSM document.
Content *string
// The date the SSM document was created.
CreatedDate *time.Time
// The friendly name of the SSM document. This value can differ for each version
// of the document. If you want to update this value, see UpdateDocument .
DisplayName *string
// The document format, either JSON or YAML.
DocumentFormat types.DocumentFormat
// The document type.
DocumentType types.DocumentType
// The document version.
DocumentVersion *string
// The name of the SSM document.
Name *string
// A list of SSM documents required by a document. For example, an
// ApplicationConfiguration document requires an ApplicationConfigurationSchema
// document.
Requires []types.DocumentRequires
// The current review status of a new custom Systems Manager document (SSM
// document) created by a member of your organization, or of the latest version of
// an existing SSM document. Only one version of an SSM document can be in the
// APPROVED state at a time. When a new version is approved, the status of the
// previous version changes to REJECTED. Only one version of an SSM document can be
// in review, or PENDING, at a time.
ReviewStatus types.ReviewStatus
// The status of the SSM document, such as Creating , Active , Updating , Failed ,
// and Deleting .
Status types.DocumentStatus
// A message returned by Amazon Web Services Systems Manager that explains the
// Status value. For example, a Failed status might be explained by the
// StatusInformation message, "The specified S3 bucket doesn't exist. Verify that
// the URL of the S3 bucket is correct."
StatusInformation *string
// The version of the artifact associated with the document. For example, "Release
// 12, Update 6". This value is unique across all versions of a document, and can't
// be changed.
VersionName *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetDocumentMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetDocument{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetDocument{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetDocument"); 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 = addOpGetDocumentValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetDocument(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_opGetDocument(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetDocument",
}
}
|