// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. package secretsmanager import ( "context" "fmt" "github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/internal/awsutil" "github.com/aws/aws-sdk-go-v2/private/protocol" "github.com/aws/aws-sdk-go-v2/private/protocol/jsonrpc" ) type TagResourceInput struct { _ struct{} `type:"structure"` // The identifier for the secret that you want to attach tags to. You can specify // either the Amazon Resource Name (ARN) or the friendly name of the secret. // // If you specify an ARN, we generally recommend that you specify a complete // ARN. You can specify a partial ARN too—for example, if you don’t include // the final hyphen and six random characters that Secrets Manager adds at the // end of the ARN when you created the secret. A partial ARN match can work // as long as it uniquely matches only one secret. However, if your secret has // a name that ends in a hyphen followed by six characters (before Secrets Manager // adds the hyphen and six characters to the ARN) and you try to use that as // a partial ARN, then those characters cause Secrets Manager to assume that // you’re specifying a complete ARN. This confusion can cause unexpected results. // To avoid this situation, we recommend that you don’t create secret names // ending with a hyphen followed by six characters. // // If you specify an incomplete ARN without the random suffix, and instead provide // the 'friendly name', you must not include the random suffix. If you do include // the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException // or an AccessDeniedException error, depending on your permissions. // // SecretId is a required field SecretId *string `min:"1" type:"string" required:"true"` // The tags to attach to the secret. Each element in the list consists of a // Key and a Value. // // This parameter to the API requires a JSON text string argument. For information // on how to format a JSON parameter for the various command line tool environments, // see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) // in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax: // --Tags Key="Key1",Value="Value1",Key="Key2",Value="Value2"[,…] // // Tags is a required field Tags []Tag `type:"list" required:"true"` } // String returns the string representation func (s TagResourceInput) String() string { return awsutil.Prettify(s) } // Validate inspects the fields of the type to determine if they are valid. func (s *TagResourceInput) Validate() error { invalidParams := aws.ErrInvalidParams{Context: "TagResourceInput"} if s.SecretId == nil { invalidParams.Add(aws.NewErrParamRequired("SecretId")) } if s.SecretId != nil && len(*s.SecretId) < 1 { invalidParams.Add(aws.NewErrParamMinLen("SecretId", 1)) } if s.Tags == nil { invalidParams.Add(aws.NewErrParamRequired("Tags")) } if s.Tags != nil { for i, v := range s.Tags { if err := v.Validate(); err != nil { invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(aws.ErrInvalidParams)) } } } if invalidParams.Len() > 0 { return invalidParams } return nil } type TagResourceOutput struct { _ struct{} `type:"structure"` } // String returns the string representation func (s TagResourceOutput) String() string { return awsutil.Prettify(s) } const opTagResource = "TagResource" // TagResourceRequest returns a request value for making API operation for // AWS Secrets Manager. // // Attaches one or more tags, each consisting of a key name and a value, to // the specified secret. Tags are part of the secret's overall metadata, and // are not associated with any specific version of the secret. This operation // only appends tags to the existing list of tags. To remove tags, you must // use UntagResource. // // The following basic restrictions apply to tags: // // * Maximum number of tags per secret—50 // // * Maximum key length—127 Unicode characters in UTF-8 // // * Maximum value length—255 Unicode characters in UTF-8 // // * Tag keys and values are case sensitive. // // * Do not use the aws: prefix in your tag names or values because AWS reserves // it for AWS use. You can't edit or delete tag names or values with this // prefix. Tags with this prefix do not count against your tags per secret // limit. // // * If you use your tagging schema across multiple services and resources, // remember other services might have restrictions on allowed characters. // Generally allowed characters: letters, spaces, and numbers representable // in UTF-8, plus the following special characters: + - = . _ : / @. // // If you use tags as part of your security strategy, then adding or removing // a tag can change permissions. If successfully completing this operation would // result in you losing your permissions for this secret, then the operation // is blocked and returns an Access Denied error. // // Minimum permissions // // To run this command, you must have the following permissions: // // * secretsmanager:TagResource // // Related operations // // * To remove one or more tags from the collection attached to a secret, // use UntagResource. // // * To view the list of tags attached to a secret, use DescribeSecret. // // // Example sending a request using TagResourceRequest. // req := client.TagResourceRequest(params) // resp, err := req.Send(context.TODO()) // if err == nil { // fmt.Println(resp) // } // // Please also see https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/TagResource func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest { op := &aws.Operation{ Name: opTagResource, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &TagResourceInput{} } req := c.newRequest(op, input, &TagResourceOutput{}) req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler) req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler) return TagResourceRequest{Request: req, Input: input, Copy: c.TagResourceRequest} } // TagResourceRequest is the request type for the // TagResource API operation. type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest } // Send marshals and sends the TagResource API request. func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error) { r.Request.SetContext(ctx) err := r.Request.Send() if err != nil { return nil, err } resp := &TagResourceResponse{ TagResourceOutput: r.Request.Data.(*TagResourceOutput), response: &aws.Response{Request: r.Request}, } return resp, nil } // TagResourceResponse is the response type for the // TagResource API operation. type TagResourceResponse struct { *TagResourceOutput response *aws.Response } // SDKResponseMetdata returns the response metadata for the // TagResource request. func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response { return r.response }