1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package storagegateway
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/smithy-go/middleware"
10	smithyhttp "github.com/aws/smithy-go/transport/http"
11)
12
13// Assigns a tape to a tape pool for archiving. The tape assigned to a pool is
14// archived in the S3 storage class that is associated with the pool. When you use
15// your backup application to eject the tape, the tape is archived directly into
16// the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to
17// the pool. Valid Values: GLACIER | DEEP_ARCHIVE
18func (c *Client) AssignTapePool(ctx context.Context, params *AssignTapePoolInput, optFns ...func(*Options)) (*AssignTapePoolOutput, error) {
19	if params == nil {
20		params = &AssignTapePoolInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "AssignTapePool", params, optFns, addOperationAssignTapePoolMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*AssignTapePoolOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33type AssignTapePoolInput struct {
34
35	// The ID of the pool that you want to add your tape to for archiving. The tape in
36	// this pool is archived in the S3 storage class that is associated with the pool.
37	// When you use your backup application to eject the tape, the tape is archived
38	// directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that
39	// corresponds to the pool. Valid Values: GLACIER | DEEP_ARCHIVE
40	//
41	// This member is required.
42	PoolId *string
43
44	// The unique Amazon Resource Name (ARN) of the virtual tape that you want to add
45	// to the tape pool.
46	//
47	// This member is required.
48	TapeARN *string
49
50	// Set permissions to bypass governance retention. If the lock type of the archived
51	// tape is Governance, the tape's archived age is not older than
52	// RetentionLockInDays, and the user does not already have
53	// BypassGovernanceRetention, setting this to TRUE enables the user to bypass the
54	// retention lock. This parameter is set to true by default for calls from the
55	// console. Valid values: TRUE | FALSE
56	BypassGovernanceRetention bool
57}
58
59type AssignTapePoolOutput struct {
60
61	// The unique Amazon Resource Names (ARN) of the virtual tape that was added to the
62	// tape pool.
63	TapeARN *string
64
65	// Metadata pertaining to the operation's result.
66	ResultMetadata middleware.Metadata
67}
68
69func addOperationAssignTapePoolMiddlewares(stack *middleware.Stack, options Options) (err error) {
70	err = stack.Serialize.Add(&awsAwsjson11_serializeOpAssignTapePool{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpAssignTapePool{}, middleware.After)
75	if err != nil {
76		return err
77	}
78	if err = addSetLoggerMiddleware(stack, options); err != nil {
79		return err
80	}
81	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
82		return err
83	}
84	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
85		return err
86	}
87	if err = addResolveEndpointMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
91		return err
92	}
93	if err = addRetryMiddlewares(stack, options); err != nil {
94		return err
95	}
96	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
103		return err
104	}
105	if err = addClientUserAgent(stack); err != nil {
106		return err
107	}
108	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
109		return err
110	}
111	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addOpAssignTapePoolValidationMiddleware(stack); err != nil {
115		return err
116	}
117	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAssignTapePool(options.Region), middleware.Before); err != nil {
118		return err
119	}
120	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addResponseErrorMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addRequestResponseLogging(stack, options); err != nil {
127		return err
128	}
129	return nil
130}
131
132func newServiceMetadataMiddleware_opAssignTapePool(region string) *awsmiddleware.RegisterServiceMetadata {
133	return &awsmiddleware.RegisterServiceMetadata{
134		Region:        region,
135		ServiceID:     ServiceID,
136		SigningName:   "storagegateway",
137		OperationName: "AssignTapePool",
138	}
139}
140