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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package s3
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
s3cust "github.com/aws/aws-sdk-go-v2/service/s3/internal/customizations"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns metadata about all versions of the objects in a bucket. You can also use
// request parameters as selection criteria to return metadata about a subset of
// all the object versions. To use this operation, you must have permissions to
// perform the s3:ListBucketVersions action. Be aware of the name difference. A 200
// OK response can contain valid or invalid XML. Make sure to design your
// application to parse the contents of the response and handle it appropriately.
// To use this operation, you must have READ access to the bucket. This action is
// not supported by Amazon S3 on Outposts. The following operations are related to
// ListObjectVersions:
//
// * ListObjectsV2
// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
//
// *
// GetObject
// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
//
// *
// PutObject
// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
//
// *
// DeleteObject
// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
func (c *Client) ListObjectVersions(ctx context.Context, params *ListObjectVersionsInput, optFns ...func(*Options)) (*ListObjectVersionsOutput, error) {
if params == nil {
params = &ListObjectVersionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListObjectVersions", params, optFns, c.addOperationListObjectVersionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListObjectVersionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListObjectVersionsInput struct {
// The bucket name that contains the objects.
//
// This member is required.
Bucket *string
// A delimiter is a character that you specify to group keys. All keys that contain
// the same string between the prefix and the first occurrence of the delimiter are
// grouped under a single result element in CommonPrefixes. These groups are
// counted as one result against the max-keys limitation. These keys are not
// returned elsewhere in the response.
Delimiter *string
// Requests Amazon S3 to encode the object keys in the response and specifies the
// encoding method to use. An object key may contain any Unicode character;
// however, XML 1.0 parser cannot parse some characters, such as characters with an
// ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you
// can add this parameter to request that Amazon S3 encode the keys in the
// response.
EncodingType types.EncodingType
// The account ID of the expected bucket owner. If the bucket is owned by a
// different account, the request fails with the HTTP status code 403 Forbidden
// (access denied).
ExpectedBucketOwner *string
// Specifies the key to start with when listing objects in a bucket.
KeyMarker *string
// Sets the maximum number of keys returned in the response. By default the action
// returns up to 1,000 key names. The response might contain fewer keys but will
// never contain more. If additional keys satisfy the search criteria, but were not
// returned because max-keys was exceeded, the response contains true. To return
// the additional keys, see key-marker and version-id-marker.
MaxKeys int32
// Use this parameter to select only those keys that begin with the specified
// prefix. You can use prefixes to separate a bucket into different groupings of
// keys. (You can think of using prefix to make groups in the same way you'd use a
// folder in a file system.) You can use prefix with delimiter to roll up numerous
// objects into a single result under CommonPrefixes.
Prefix *string
// Specifies the object version you want to start listing from.
VersionIdMarker *string
noSmithyDocumentSerde
}
type ListObjectVersionsOutput struct {
// All of the keys rolled up into a common prefix count as a single return when
// calculating the number of returns.
CommonPrefixes []types.CommonPrefix
// Container for an object that is a delete marker.
DeleteMarkers []types.DeleteMarkerEntry
// The delimiter grouping the included keys. A delimiter is a character that you
// specify to group keys. All keys that contain the same string between the prefix
// and the first occurrence of the delimiter are grouped under a single result
// element in CommonPrefixes. These groups are counted as one result against the
// max-keys limitation. These keys are not returned elsewhere in the response.
Delimiter *string
// Encoding type used by Amazon S3 to encode object key names in the XML response.
// If you specify encoding-type request parameter, Amazon S3 includes this element
// in the response, and returns encoded key name values in the following response
// elements: KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.
EncodingType types.EncodingType
// A flag that indicates whether Amazon S3 returned all of the results that
// satisfied the search criteria. If your results were truncated, you can make a
// follow-up paginated request using the NextKeyMarker and NextVersionIdMarker
// response parameters as a starting place in another request to return the rest of
// the results.
IsTruncated bool
// Marks the last key returned in a truncated response.
KeyMarker *string
// Specifies the maximum number of objects to return.
MaxKeys int32
// The bucket name.
Name *string
// When the number of responses exceeds the value of MaxKeys, NextKeyMarker
// specifies the first key not returned that satisfies the search criteria. Use
// this value for the key-marker request parameter in a subsequent request.
NextKeyMarker *string
// When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker
// specifies the first object version not returned that satisfies the search
// criteria. Use this value for the version-id-marker request parameter in a
// subsequent request.
NextVersionIdMarker *string
// Selects objects that start with the value supplied by this parameter.
Prefix *string
// Marks the last version of the key returned in a truncated response.
VersionIdMarker *string
// Container for version information.
Versions []types.ObjectVersion
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListObjectVersionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestxml_serializeOpListObjectVersions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestxml_deserializeOpListObjectVersions{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = swapWithCustomHTTPSignerMiddleware(stack, options); err != nil {
return err
}
if err = addOpListObjectVersionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListObjectVersions(options.Region), middleware.Before); err != nil {
return err
}
if err = addMetadataRetrieverMiddleware(stack); err != nil {
return err
}
if err = addListObjectVersionsUpdateEndpoint(stack, options); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = v4.AddContentSHA256HeaderMiddleware(stack); err != nil {
return err
}
if err = disableAcceptEncodingGzip(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opListObjectVersions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "s3",
OperationName: "ListObjectVersions",
}
}
// getListObjectVersionsBucketMember returns a pointer to string denoting a
// provided bucket member valueand a boolean indicating if the input has a modeled
// bucket name,
func getListObjectVersionsBucketMember(input interface{}) (*string, bool) {
in := input.(*ListObjectVersionsInput)
if in.Bucket == nil {
return nil, false
}
return in.Bucket, true
}
func addListObjectVersionsUpdateEndpoint(stack *middleware.Stack, options Options) error {
return s3cust.UpdateEndpoint(stack, s3cust.UpdateEndpointOptions{
Accessor: s3cust.UpdateEndpointParameterAccessor{
GetBucketFromInput: getListObjectVersionsBucketMember,
},
UsePathStyle: options.UsePathStyle,
UseAccelerate: options.UseAccelerate,
SupportsAccelerate: true,
TargetS3ObjectLambda: false,
EndpointResolver: options.EndpointResolver,
EndpointResolverOptions: options.EndpointOptions,
UseARNRegion: options.UseARNRegion,
DisableMultiRegionAccessPoints: options.DisableMultiRegionAccessPoints,
})
}
|