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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package pinpointsmsvoicev2
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/pinpointsmsvoicev2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Deletes an existing pool. Deleting a pool disassociates all origination
// identities from that pool. If the pool status isn't active or if deletion
// protection is enabled, an error is returned. A pool is a collection of phone
// numbers and SenderIds. A pool can include one or more phone numbers and
// SenderIds that are associated with your Amazon Web Services account.
func (c *Client) DeletePool(ctx context.Context, params *DeletePoolInput, optFns ...func(*Options)) (*DeletePoolOutput, error) {
if params == nil {
params = &DeletePoolInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DeletePool", params, optFns, c.addOperationDeletePoolMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DeletePoolOutput)
out.ResultMetadata = metadata
return out, nil
}
type DeletePoolInput struct {
// The PoolId or PoolArn of the pool to delete. You can use DescribePools to find
// the values for PoolId and PoolArn .
//
// This member is required.
PoolId *string
noSmithyDocumentSerde
}
type DeletePoolOutput struct {
// The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/)
// format.
CreatedTimestamp *time.Time
// The message type that was associated with the deleted pool.
MessageType types.MessageType
// The name of the OptOutList that was associated with the deleted pool.
OptOutListName *string
// The Amazon Resource Name (ARN) of the pool that was deleted.
PoolArn *string
// The PoolId of the pool that was deleted.
PoolId *string
// By default this is set to false. When an end recipient sends a message that
// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
// automatically replies with a customizable message and adds the end recipient to
// the OptOutList. When set to true you're responsible for responding to HELP and
// STOP requests. You're also responsible for tracking and honoring opt-out
// requests.
SelfManagedOptOutsEnabled bool
// Indicates whether shared routes are enabled for the pool.
SharedRoutesEnabled bool
// The current status of the pool.
// - CREATING: The pool is currently being created and isn't yet available for
// use.
// - ACTIVE: The pool is active and available for use.
// - DELETING: The pool is being deleted.
Status types.PoolStatus
// The Amazon Resource Name (ARN) of the TwoWayChannel.
TwoWayChannelArn *string
// An optional IAM Role Arn for a service to assume, to be able to post inbound
// SMS messages.
TwoWayChannelRole *string
// By default this is set to false. When set to true you can receive incoming text
// messages from your end recipients.
TwoWayEnabled bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDeletePoolMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpDeletePool{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpDeletePool{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DeletePool"); 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 = addOpDeletePoolValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeletePool(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_opDeletePool(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DeletePool",
}
}
|