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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package bedrock
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/bedrock/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates a guardrail to block topics and to implement safeguards for your
// generative AI applications.
//
// You can configure the following policies in a guardrail to avoid undesirable
// and harmful content, filter out denied topics and words, and remove sensitive
// information for privacy protection.
//
// - Content filters - Adjust filter strengths to block input prompts or model
// responses containing harmful content.
//
// - Denied topics - Define a set of topics that are undesirable in the context
// of your application. These topics will be blocked if detected in user queries or
// model responses.
//
// - Word filters - Configure filters to block undesirable words, phrases, and
// profanity. Such words can include offensive terms, competitor names etc.
//
// - Sensitive information filters - Block or mask sensitive information such as
// personally identifiable information (PII) or custom regex in user inputs and
// model responses.
//
// In addition to the above policies, you can also configure the messages to be
// returned to the user if a user input or model response is in violation of the
// policies defined in the guardrail.
//
// For more information, see [Guardrails for Amazon Bedrock] in the Amazon Bedrock User Guide.
//
// [Guardrails for Amazon Bedrock]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html
func (c *Client) CreateGuardrail(ctx context.Context, params *CreateGuardrailInput, optFns ...func(*Options)) (*CreateGuardrailOutput, error) {
if params == nil {
params = &CreateGuardrailInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateGuardrail", params, optFns, c.addOperationCreateGuardrailMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateGuardrailOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateGuardrailInput struct {
// The message to return when the guardrail blocks a prompt.
//
// This member is required.
BlockedInputMessaging *string
// The message to return when the guardrail blocks a model response.
//
// This member is required.
BlockedOutputsMessaging *string
// The name to give the guardrail.
//
// This member is required.
Name *string
// A unique, case-sensitive identifier to ensure that the API request completes no
// more than once. If this token matches a previous request, Amazon Bedrock ignores
// the request, but does not return an error. For more information, see [Ensuring idempotency]in the
// Amazon S3 User Guide.
//
// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
ClientRequestToken *string
// The content filter policies to configure for the guardrail.
ContentPolicyConfig *types.GuardrailContentPolicyConfig
// The contextual grounding policy configuration used to create a guardrail.
ContextualGroundingPolicyConfig *types.GuardrailContextualGroundingPolicyConfig
// A description of the guardrail.
Description *string
// The ARN of the KMS key that you use to encrypt the guardrail.
KmsKeyId *string
// The sensitive information policy to configure for the guardrail.
SensitiveInformationPolicyConfig *types.GuardrailSensitiveInformationPolicyConfig
// The tags that you want to attach to the guardrail.
Tags []types.Tag
// The topic policies to configure for the guardrail.
TopicPolicyConfig *types.GuardrailTopicPolicyConfig
// The word policy you configure for the guardrail.
WordPolicyConfig *types.GuardrailWordPolicyConfig
noSmithyDocumentSerde
}
type CreateGuardrailOutput struct {
// The time at which the guardrail was created.
//
// This member is required.
CreatedAt *time.Time
// The ARN of the guardrail.
//
// This member is required.
GuardrailArn *string
// The unique identifier of the guardrail that was created.
//
// This member is required.
GuardrailId *string
// The version of the guardrail that was created. This value will always be DRAFT .
//
// This member is required.
Version *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateGuardrailMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateGuardrail{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateGuardrail{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateGuardrail"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addIdempotencyToken_opCreateGuardrailMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateGuardrailValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateGuardrail(options.Region), middleware.Before); err != nil {
return err
}
if err = 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
}
type idempotencyToken_initializeOpCreateGuardrail struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateGuardrail) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateGuardrail) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateGuardrailInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateGuardrailInput ")
}
if input.ClientRequestToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientRequestToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateGuardrailMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateGuardrail{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateGuardrail(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateGuardrail",
}
}
|