api_op_DeleteContactMethod.go raw

   1  // Code generated by smithy-go-codegen DO NOT EDIT.
   2  
   3  package lightsail
   4  
   5  import (
   6  	"context"
   7  	"fmt"
   8  	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
   9  	"github.com/aws/aws-sdk-go-v2/service/lightsail/types"
  10  	"github.com/aws/smithy-go/middleware"
  11  	smithyhttp "github.com/aws/smithy-go/transport/http"
  12  )
  13  
  14  // Deletes a contact method.
  15  //
  16  // A contact method is used to send you notifications about your Amazon Lightsail
  17  // resources. You can add one email address and one mobile phone number contact
  18  // method in each Amazon Web Services Region. However, SMS text messaging is not
  19  // supported in some Amazon Web Services Regions, and SMS text messages cannot be
  20  // sent to some countries/regions. For more information, see [Notifications in Amazon Lightsail].
  21  //
  22  // [Notifications in Amazon Lightsail]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications
  23  func (c *Client) DeleteContactMethod(ctx context.Context, params *DeleteContactMethodInput, optFns ...func(*Options)) (*DeleteContactMethodOutput, error) {
  24  	if params == nil {
  25  		params = &DeleteContactMethodInput{}
  26  	}
  27  
  28  	result, metadata, err := c.invokeOperation(ctx, "DeleteContactMethod", params, optFns, c.addOperationDeleteContactMethodMiddlewares)
  29  	if err != nil {
  30  		return nil, err
  31  	}
  32  
  33  	out := result.(*DeleteContactMethodOutput)
  34  	out.ResultMetadata = metadata
  35  	return out, nil
  36  }
  37  
  38  type DeleteContactMethodInput struct {
  39  
  40  	// The protocol that will be deleted, such as Email or SMS (text messaging).
  41  	//
  42  	// To delete an Email and an SMS contact method if you added both, you must run
  43  	// separate DeleteContactMethod actions to delete each protocol.
  44  	//
  45  	// This member is required.
  46  	Protocol types.ContactProtocol
  47  
  48  	noSmithyDocumentSerde
  49  }
  50  
  51  type DeleteContactMethodOutput struct {
  52  
  53  	// An array of objects that describe the result of the action, such as the status
  54  	// of the request, the timestamp of the request, and the resources affected by the
  55  	// request.
  56  	Operations []types.Operation
  57  
  58  	// Metadata pertaining to the operation's result.
  59  	ResultMetadata middleware.Metadata
  60  
  61  	noSmithyDocumentSerde
  62  }
  63  
  64  func (c *Client) addOperationDeleteContactMethodMiddlewares(stack *middleware.Stack, options Options) (err error) {
  65  	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
  66  		return err
  67  	}
  68  	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteContactMethod{}, middleware.After)
  69  	if err != nil {
  70  		return err
  71  	}
  72  	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteContactMethod{}, middleware.After)
  73  	if err != nil {
  74  		return err
  75  	}
  76  	if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteContactMethod"); err != nil {
  77  		return fmt.Errorf("add protocol finalizers: %v", err)
  78  	}
  79  
  80  	if err = addlegacyEndpointContextSetter(stack, options); err != nil {
  81  		return err
  82  	}
  83  	if err = addSetLoggerMiddleware(stack, options); err != nil {
  84  		return err
  85  	}
  86  	if err = addClientRequestID(stack); err != nil {
  87  		return err
  88  	}
  89  	if err = addComputeContentLength(stack); err != nil {
  90  		return err
  91  	}
  92  	if err = addResolveEndpointMiddleware(stack, options); err != nil {
  93  		return err
  94  	}
  95  	if err = addComputePayloadSHA256(stack); err != nil {
  96  		return err
  97  	}
  98  	if err = addRetry(stack, options); err != nil {
  99  		return err
 100  	}
 101  	if err = addRawResponseToMetadata(stack); err != nil {
 102  		return err
 103  	}
 104  	if err = addRecordResponseTiming(stack); err != nil {
 105  		return err
 106  	}
 107  	if err = addSpanRetryLoop(stack, options); err != nil {
 108  		return err
 109  	}
 110  	if err = addClientUserAgent(stack, options); err != nil {
 111  		return err
 112  	}
 113  	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
 114  		return err
 115  	}
 116  	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
 117  		return err
 118  	}
 119  	if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
 120  		return err
 121  	}
 122  	if err = addTimeOffsetBuild(stack, c); err != nil {
 123  		return err
 124  	}
 125  	if err = addUserAgentRetryMode(stack, options); err != nil {
 126  		return err
 127  	}
 128  	if err = addCredentialSource(stack, options); err != nil {
 129  		return err
 130  	}
 131  	if err = addOpDeleteContactMethodValidationMiddleware(stack); err != nil {
 132  		return err
 133  	}
 134  	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteContactMethod(options.Region), middleware.Before); err != nil {
 135  		return err
 136  	}
 137  	if err = addRecursionDetection(stack); err != nil {
 138  		return err
 139  	}
 140  	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
 141  		return err
 142  	}
 143  	if err = addResponseErrorMiddleware(stack); err != nil {
 144  		return err
 145  	}
 146  	if err = addRequestResponseLogging(stack, options); err != nil {
 147  		return err
 148  	}
 149  	if err = addDisableHTTPSMiddleware(stack, options); err != nil {
 150  		return err
 151  	}
 152  	if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
 153  		return err
 154  	}
 155  	if err = addInterceptAttempt(stack, options); err != nil {
 156  		return err
 157  	}
 158  	if err = addInterceptors(stack, options); err != nil {
 159  		return err
 160  	}
 161  	return nil
 162  }
 163  
 164  func newServiceMetadataMiddleware_opDeleteContactMethod(region string) *awsmiddleware.RegisterServiceMetadata {
 165  	return &awsmiddleware.RegisterServiceMetadata{
 166  		Region:        region,
 167  		ServiceID:     ServiceID,
 168  		OperationName: "DeleteContactMethod",
 169  	}
 170  }
 171